Skip to content

Commit e4a4285

Browse files
authored
_load_remote_dataset: Rename parameter names and remove trailing underscore from prefix (#3202)
* Rename parameter names in _load_remote_datasets * Remove the trailing underscore from dataset prefix * Fix one test
1 parent bc673bc commit e4a4285

14 files changed

+40
-40
lines changed

pygmt/datasets/earth_age.py

+2-2
Original file line numberDiff line numberDiff line change
@@ -100,8 +100,8 @@ def load_earth_age(
100100
... )
101101
"""
102102
grid = _load_remote_dataset(
103-
dataset_name="earth_age",
104-
dataset_prefix="earth_age_",
103+
name="earth_age",
104+
prefix="earth_age",
105105
resolution=resolution,
106106
region=region,
107107
registration=registration,

pygmt/datasets/earth_free_air_anomaly.py

+2-2
Original file line numberDiff line numberDiff line change
@@ -102,8 +102,8 @@ def load_earth_free_air_anomaly(
102102
... )
103103
"""
104104
grid = _load_remote_dataset(
105-
dataset_name="earth_faa",
106-
dataset_prefix="earth_faa_",
105+
name="earth_faa",
106+
prefix="earth_faa",
107107
resolution=resolution,
108108
region=region,
109109
registration=registration,

pygmt/datasets/earth_geoid.py

+2-2
Original file line numberDiff line numberDiff line change
@@ -93,8 +93,8 @@ def load_earth_geoid(
9393
... )
9494
"""
9595
grid = _load_remote_dataset(
96-
dataset_name="earth_geoid",
97-
dataset_prefix="earth_geoid_",
96+
name="earth_geoid",
97+
prefix="earth_geoid",
9898
resolution=resolution,
9999
region=region,
100100
registration=registration,

pygmt/datasets/earth_magnetic_anomaly.py

+5-5
Original file line numberDiff line numberDiff line change
@@ -137,9 +137,9 @@ def load_earth_magnetic_anomaly(
137137
... )
138138
"""
139139
magnetic_anomaly_sources = {
140-
"emag2": "earth_mag_",
141-
"emag2_4km": "earth_mag4km_",
142-
"wdmam": "earth_wdmam_",
140+
"emag2": "earth_mag",
141+
"emag2_4km": "earth_mag4km",
142+
"wdmam": "earth_wdmam",
143143
}
144144
if data_source not in magnetic_anomaly_sources:
145145
raise GMTInvalidInput(
@@ -149,8 +149,8 @@ def load_earth_magnetic_anomaly(
149149
dataset_prefix = magnetic_anomaly_sources[data_source]
150150
dataset_name = "earth_wdmam" if data_source == "wdmam" else "earth_mag"
151151
grid = _load_remote_dataset(
152-
dataset_name=dataset_name,
153-
dataset_prefix=dataset_prefix,
152+
name=dataset_name,
153+
prefix=dataset_prefix,
154154
resolution=resolution,
155155
region=region,
156156
registration=registration,

pygmt/datasets/earth_mask.py

+2-2
Original file line numberDiff line numberDiff line change
@@ -97,8 +97,8 @@ def load_earth_mask(
9797
array(0, dtype=int8)
9898
"""
9999
grid = _load_remote_dataset(
100-
dataset_name="earth_mask",
101-
dataset_prefix="earth_mask_",
100+
name="earth_mask",
101+
prefix="earth_mask",
102102
resolution=resolution,
103103
region=region,
104104
registration=registration,

pygmt/datasets/earth_relief.py

+7-7
Original file line numberDiff line numberDiff line change
@@ -140,10 +140,10 @@ def load_earth_relief(
140140
land_only_srtm_resolutions = ["03s", "01s"]
141141

142142
earth_relief_sources = {
143-
"igpp": "earth_relief_",
144-
"gebco": "earth_gebco_",
145-
"gebcosi": "earth_gebcosi_",
146-
"synbath": "earth_synbath_",
143+
"igpp": "earth_relief",
144+
"gebco": "earth_gebco",
145+
"gebcosi": "earth_gebcosi",
146+
"synbath": "earth_synbath",
147147
}
148148
if data_source not in earth_relief_sources:
149149
raise GMTInvalidInput(
@@ -153,7 +153,7 @@ def load_earth_relief(
153153
# Choose earth relief data prefix
154154
if use_srtm and resolution in land_only_srtm_resolutions:
155155
if data_source == "igpp":
156-
dataset_prefix = "srtm_relief_"
156+
dataset_prefix = "srtm_relief"
157157
else:
158158
raise GMTInvalidInput(
159159
f"Option 'use_srtm=True' doesn't work with data source '{data_source}'."
@@ -168,8 +168,8 @@ def load_earth_relief(
168168
case "gebco" | "gebcosi":
169169
dataset_name = "earth_gebco"
170170
grid = _load_remote_dataset(
171-
dataset_name=dataset_name,
172-
dataset_prefix=dataset_prefix,
171+
name=dataset_name,
172+
prefix=dataset_prefix,
173173
resolution=resolution,
174174
region=region,
175175
registration=registration,

pygmt/datasets/earth_vertical_gravity_gradient.py

+2-2
Original file line numberDiff line numberDiff line change
@@ -104,8 +104,8 @@ def load_earth_vertical_gravity_gradient(
104104
... )
105105
"""
106106
grid = _load_remote_dataset(
107-
dataset_name="earth_vgg",
108-
dataset_prefix="earth_vgg_",
107+
name="earth_vgg",
108+
prefix="earth_vgg",
109109
resolution=resolution,
110110
region=region,
111111
registration=registration,

pygmt/datasets/load_remote_dataset.py

+6-6
Original file line numberDiff line numberDiff line change
@@ -330,8 +330,8 @@ class GMTRemoteDataset(NamedTuple):
330330

331331
@kwargs_to_strings(region="sequence")
332332
def _load_remote_dataset(
333-
dataset_name: str,
334-
dataset_prefix: str,
333+
name: str,
334+
prefix: str,
335335
resolution: str,
336336
region: str | list,
337337
registration: Literal["gridline", "pixel", None],
@@ -341,9 +341,9 @@ def _load_remote_dataset(
341341
342342
Parameters
343343
----------
344-
dataset_name
344+
name
345345
The name for the dataset in the 'datasets' dictionary.
346-
dataset_prefix
346+
prefix
347347
The prefix for the dataset that will be passed to the GMT C API.
348348
resolution
349349
The grid resolution. The suffix ``d``, ``m``, and ``s`` stand for arc-degrees,
@@ -373,7 +373,7 @@ def _load_remote_dataset(
373373
plotting functions. Refer to :class:`pygmt.GMTDataArrayAccessor` for detailed
374374
explanations and workarounds.
375375
"""
376-
dataset = datasets[dataset_name]
376+
dataset = datasets[name]
377377

378378
# Check resolution
379379
if resolution not in dataset.resolutions:
@@ -401,7 +401,7 @@ def _load_remote_dataset(
401401
"returned unless only the pixel-registered grid is available."
402402
)
403403

404-
fname = f"@{dataset_prefix}{resolution}_{registration[0]}"
404+
fname = f"@{prefix}_{resolution}_{registration[0]}"
405405
if resinfo.tiled and region is None:
406406
raise GMTInvalidInput(
407407
f"'region' is required for {dataset.description} resolution '{resolution}'."

pygmt/datasets/mars_relief.py

+2-2
Original file line numberDiff line numberDiff line change
@@ -96,8 +96,8 @@ def load_mars_relief(
9696
... )
9797
"""
9898
grid = _load_remote_dataset(
99-
dataset_name="mars_relief",
100-
dataset_prefix="mars_relief_",
99+
name="mars_relief",
100+
prefix="mars_relief",
101101
resolution=resolution,
102102
region=region,
103103
registration=registration,

pygmt/datasets/mercury_relief.py

+2-2
Original file line numberDiff line numberDiff line change
@@ -96,8 +96,8 @@ def load_mercury_relief(
9696
... )
9797
"""
9898
grid = _load_remote_dataset(
99-
dataset_name="mercury_relief",
100-
dataset_prefix="mercury_relief_",
99+
name="mercury_relief",
100+
prefix="mercury_relief",
101101
resolution=resolution,
102102
region=region,
103103
registration=registration,

pygmt/datasets/moon_relief.py

+2-2
Original file line numberDiff line numberDiff line change
@@ -96,8 +96,8 @@ def load_moon_relief(
9696
... )
9797
"""
9898
grid = _load_remote_dataset(
99-
dataset_name="moon_relief",
100-
dataset_prefix="moon_relief_",
99+
name="moon_relief",
100+
prefix="moon_relief",
101101
resolution=resolution,
102102
region=region,
103103
registration=registration,

pygmt/datasets/pluto_relief.py

+2-2
Original file line numberDiff line numberDiff line change
@@ -96,8 +96,8 @@ def load_pluto_relief(
9696
... )
9797
"""
9898
grid = _load_remote_dataset(
99-
dataset_name="pluto_relief",
100-
dataset_prefix="pluto_relief_",
99+
name="pluto_relief",
100+
prefix="pluto_relief",
101101
resolution=resolution,
102102
region=region,
103103
registration=registration,

pygmt/datasets/venus_relief.py

+2-2
Original file line numberDiff line numberDiff line change
@@ -93,8 +93,8 @@ def load_venus_relief(
9393
... )
9494
"""
9595
grid = _load_remote_dataset(
96-
dataset_name="venus_relief",
97-
dataset_prefix="venus_relief_",
96+
name="venus_relief",
97+
prefix="venus_relief",
9898
resolution=resolution,
9999
region=region,
100100
registration=registration,

pygmt/tests/test_datasets_load_remote_datasets.py

+2-2
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,8 @@ def load_remote_dataset_wrapper(resolution="01d", region=None, registration=None
1212
Wrapper for _load_remote_dataset using the earth age dataset as an example.
1313
"""
1414
return _load_remote_dataset(
15-
dataset_name="earth_age",
16-
dataset_prefix="earth_age_",
15+
name="earth_age",
16+
prefix="earth_age",
1717
resolution=resolution,
1818
region=region,
1919
registration=registration,

0 commit comments

Comments
 (0)