Skip to content

Commit b877d72

Browse files
DOC / remote datasets: Use consistently "dataset" instead of "data set" (#8646)
* Use consistently 'dataset' (not 'data set') * One for fix | Remove double with spaces
1 parent b34b125 commit b877d72

File tree

1 file changed

+27
-27
lines changed

1 file changed

+27
-27
lines changed

doc/rst/source/datasets/remote-data.rst

Lines changed: 27 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
Remote Data Sets
2-
================
1+
Remote Datasets
2+
===============
33

4-
A *remote data set* is a data set that is stored on one or more remote servers. It may
4+
A *remote dataset* is a dataset that is stored on one or more remote servers. It may
55
be a single grid file or a collection of subset tiles making up a larger grid. They
66
are not distributed with GMT or installed during the installation procedures.
77
GMT offers several remote global data grids that you can access via our *remote file* mechanism.
@@ -11,40 +11,40 @@ From then on we read the local file from there.
1111

1212
By using the remote file mechanism you should know that these files, on the server, will change
1313
from time to time (i.e., new versions are released, a problem in one file is fixed, or a dataset
14-
becomes obsolete), and GMT will take actions accordingly. It is our policy to only supply the *latest*
15-
version of any dataset that undergoes revisions. If you require previous versions for your work you
16-
will need to get those data from the data provider separately. Unless you deactivate the remote data service,
14+
becomes obsolete), and GMT will take actions accordingly. It is our policy to only supply the *latest*
15+
version of any dataset that undergoes revisions. If you require previous versions for your work you
16+
will need to get those data from the data provider separately. Unless you deactivate the remote data service,
1717
GMT will do the following when you request a remote file in a GMT command:
1818

1919
#. We check if the locally cached catalog with information about the data available from the server
20-
is up-to-date or if it needs to be refreshed. If the file is older that the :term:`GMT_DATA_UPDATE_INTERVAL`
20+
is up-to-date or if it needs to be refreshed. If the file is older that the :term:`GMT_DATA_UPDATE_INTERVAL`
2121
limit then we refresh the catalog.
2222
#. When the catalog is refreshed, we determine the publication date for each dataset on the server,
2323
and if any local copies you may have are now obsolete we will remove them to force a re-download from the server.
2424

25-
Currently Available Remote Data Sets
26-
-------------------------------------
25+
Currently Available Remote Datasets
26+
-----------------------------------
2727

2828
Documentation for the individual remote datasets available through the GMT server and its
2929
mirrors can be found at `Remote Datasets <https://www.generic-mapping-tools.org/remote-datasets/>`_.
3030

3131
Usage
3232
-----
3333

34-
We have processed and reformatted publicly available global data sets (grids and images)
35-
and standardized their file names. In GMT, you may access such data
34+
We have processed and reformatted publicly available global datasets (grids and images)
35+
and standardized their file names. In GMT, you may access such data
3636
(or a subset only by using the **-R** option) by specifying the special name
3737

3838
@remote_name_\ *rr*\ *u*\ [_\ *reg*\ ]
3939

40-
where the leading @ symbol identifies the file as a remote data set, the *remote_name_* is specific
40+
where the leading @ symbol identifies the file as a remote dataset, the *remote_name_* is specific
4141
to the dataset and the *rr* code is a 2-digit integer specifying the grid/image resolution in the
4242
unit *u*, where *u* is either **d**, **m** or **s** for arc degree, arc minute or arc second, respectively.
4343
The codes for *rr*\ *u* and the optional *reg* that are supported will be listed in the sections
44-
below describing each of the available data sets.
44+
below describing each of the available datasets.
4545

4646
When used in plots (i.e., both when a region and map projection is selected to make an image) the data
47-
resolution is optional. If it is not given then we determine a data set resolution that will result
47+
resolution is optional. If it is not given then we determine a dataset resolution that will result
4848
in a final plot image dots-per-unit resolution that is the closest to the :term:`GMT_GRAPHICS_DPU` default
4949
setting. This eliminates the need for the user to determine what grid resolution will give a nice-looking
5050
image and not create a bloated file that exceeds what the eye (or printers) can discern. Use
@@ -61,12 +61,12 @@ Data Registration
6161
-----------------
6262

6363
Optionally, you can append _\ **g** or _\ **p** to specifically get the gridline-registered or
64-
pixel-registered version (if they both exist). If *reg* is not specified then the behavior
64+
pixel-registered version (if they both exist). If *reg* is not specified then the behavior
6565
depends on whether you are making a plot or processing/extracting a subset of the data:
6666

6767
- For plots we will return the pixel-registered version unless only the gridline-registered file is available.
6868
- For grid processing modules we will return the gridline-registered version unless only the pixel-registered
69-
file is available. We will also issue a warning since for calculations you should ideally know and
69+
file is available. We will also issue a warning since for calculations you should ideally know and
7070
specify exactly what you want.
7171

7272
If you do specify a specific registration and that version is not available you will get an error message.
@@ -91,7 +91,7 @@ If you anticipate to be without an Internet connection (or have a very slow one)
9191
all (or some) of the remote files prior to losing connection with the module :doc:`/gmtget`. You
9292
can choose which data to download and limit it to node spacings larger or equal to a limit, and you
9393
can minimize space on your computer by requesting that any JPEG2000 tiles *not* be converted until GMT
94-
is accessing them. Here are some examples of usage. Download the entire cache directory used
94+
is accessing them. Here are some examples of usage. Download the entire cache directory used
9595
in examples and tests::
9696

9797
gmt get -Dcache
@@ -110,15 +110,15 @@ Typically, a dataset is released by the data provider in a single, high-resoluti
110110
To optimize use of these data in GMT and to prevent download bottlenecks we have downsampled
111111
them via Cartesian Gaussian filtering to prevent aliasing while preserving the latitude-dependent
112112
resolution in the original grid or image. To improve responsiveness, the larger files (i.e., currently
113-
for node spacings 05m and smaller) have been split into smaller tiles. When the 06m or lower resolution
113+
for node spacings 05m and smaller) have been split into smaller tiles. When the 06m or lower resolution
114114
files are accessed the first time we download the entire file, regardless of your selected region (**-R**).
115-
However, for the tiled data sets we only download the tiles that intersect your selected region
115+
However, for the tiled datasets we only download the tiles that intersect your selected region
116116
the first time they are referenced. **Note**: The mask grids are not tiled as they are very small even
117117
for 15s resolution (due to byte format and effective compression), and neither are images (at least for
118118
as long as GMT does not have the capability of blending image tiles - this may change in the future).
119119

120120
Single grids are provided as netCDF-4 maximum-lossless compressed short int grids, making the files
121-
much smaller than their original source files without any loss of precision. To minimize download
121+
much smaller than their original source files without any loss of precision. To minimize download
122122
speed, the dataset tiles are all stored as JPEG2000 images on the GMT server due to superior compression,
123123
but once downloaded to your server directory they are converted to the same short int compressed netCDF4
124124
format for easier access. This step uses our GDAL bridge and requires that your GDAL distribution was
@@ -131,24 +131,24 @@ built with *openjpeg* support.
131131
:width: 500 px
132132
:align: center
133133

134-
Histogram of compression rates for the SRTM 1x1 arc second tiles. 100% reflects the full short integer
135-
size of an uncompressed tile (~25 Mb). As can be seen, on average a JPEG2000 tile is only half the
136-
size of the corresponding fully compressed (level 9) netCDF short int grid. This is why we
134+
Histogram of compression rates for the SRTM 1x1 arc second tiles. 100% reflects the full short integer
135+
size of an uncompressed tile (~25 Mb). As can be seen, on average a JPEG2000 tile is only half the
136+
size of the corresponding fully compressed (level 9) netCDF short int grid. This is why we
137137
have chosen the JP2 format for tiles on the server.
138138

139139
Cache File Updates
140140
------------------
141141

142142
Remote cache files are our collection of miscellaneous files that are used throughout the GMT examples,
143-
man pages, and test suite. There is no system nor catalog and files come and go as we need them. The cache
144-
files are subject to similar rules as the remote data set when it comes to refreshing or deleting them.
143+
man pages, and test suite. There is no system nor catalog and files come and go as we need them. The cache
144+
files are subject to similar rules as the remote dataset when it comes to refreshing or deleting them.
145145
If any of these files is precious to you we suggest you make a copy somewhere.
146146

147-
Getting a single grid
147+
Getting a Single Grid
148148
---------------------
149149

150150
Should you need a single grid from any of our tiled dataset, e.g., to feed into other programs that do
151-
not depend on GMT, you can create that via :doc:`/grdcut`. For instance, to make a global grid from the
151+
not depend on GMT, you can create that via :doc:`/grdcut`. For instance, to make a global grid from the
152152
eight tiles that make up the 2m x 2m gridline-registered data, try::
153153

154154
gmt grdcut @earth_relief_02m_g -Gearth_at_2m.grd -Rg

0 commit comments

Comments
 (0)