diff --git a/pygmt/datasets/earth_age.py b/pygmt/datasets/earth_age.py index 03e81d703d9..ef45eac1bec 100644 --- a/pygmt/datasets/earth_age.py +++ b/pygmt/datasets/earth_age.py @@ -15,7 +15,9 @@ @kwargs_to_strings(region="sequence") def load_earth_age( - resolution="01d", + resolution: Literal[ + "01d", "30m", "20m", "15m", "10m", "06m", "05m", "04m", "03m", "02m", "01m" + ] = "01d", region=None, registration: Literal["gridline", "pixel"] = "gridline", ): @@ -51,11 +53,9 @@ def load_earth_age( Parameters ---------- - resolution : str - The grid resolution. The suffix ``d`` and ``m`` stand for - arc-degrees and arc-minutes. It can be ``"01d"``, ``"30m"``, - ``"20m"``, ``"15m"``, ``"10m"``, ``"06m"``, ``"05m"``, ``"04m"``, - ``"03m"``, ``"02m"``, or ``"01m"``. + resolution + The grid resolution. The suffix ``d`` and ``m`` stand for arc-degrees and + arc-minutes. region : str or list The subregion of the grid to load, in the form of a list diff --git a/pygmt/datasets/earth_free_air_anomaly.py b/pygmt/datasets/earth_free_air_anomaly.py index 350f54ba831..56ac3fbe324 100644 --- a/pygmt/datasets/earth_free_air_anomaly.py +++ b/pygmt/datasets/earth_free_air_anomaly.py @@ -15,7 +15,9 @@ @kwargs_to_strings(region="sequence") def load_earth_free_air_anomaly( - resolution="01d", + resolution: Literal[ + "01d", "30m", "20m", "15m", "10m", "06m", "05m", "04m", "03m", "02m", "01m" + ] = "01d", region=None, registration: Literal["gridline", "pixel", None] = None, ): @@ -51,11 +53,9 @@ def load_earth_free_air_anomaly( Parameters ---------- - resolution : str - The grid resolution. The suffix ``d`` and ``m`` stand for - arc-degrees and arc-minutes. It can be ``"01d"``, ``"30m"``, - ``"20m"``, ``"15m"``, ``"10m"``, ``"06m"``, ``"05m"``, ``"04m"``, - ``"03m"``, ``"02m"``, or ``"01m"``. + resolution + The grid resolution. The suffix ``d`` and ``m`` stand for arc-degrees and + arc-minutes. region : str or list The subregion of the grid to load, in the form of a list diff --git a/pygmt/datasets/earth_geoid.py b/pygmt/datasets/earth_geoid.py index 5190eb01413..acae0c527b3 100644 --- a/pygmt/datasets/earth_geoid.py +++ b/pygmt/datasets/earth_geoid.py @@ -15,7 +15,9 @@ @kwargs_to_strings(region="sequence") def load_earth_geoid( - resolution="01d", + resolution: Literal[ + "01d", "30m", "20m", "15m", "10m", "06m", "05m", "04m", "03m", "02m", "01m" + ] = "01d", region=None, registration: Literal["gridline", "pixel"] = "gridline", ): @@ -44,11 +46,9 @@ def load_earth_geoid( Parameters ---------- - resolution : str - The grid resolution. The suffix ``d`` and ``m`` stand for - arc-degrees and arc-minutes. It can be ``"01d"``, ``"30m"``, - ``"20m"``, ``"15m"``, ``"10m"``, ``"06m"``, ``"05m"``, ``"04m"``, - ``"03m"``, ``"02m"``, or ``"01m"``. + resolution + The grid resolution. The suffix ``d`` and ``m`` stand for arc-degrees and + arc-minutes. region : str or list The subregion of the grid to load, in the form of a list diff --git a/pygmt/datasets/earth_magnetic_anomaly.py b/pygmt/datasets/earth_magnetic_anomaly.py index b614edd1c81..869d272736a 100644 --- a/pygmt/datasets/earth_magnetic_anomaly.py +++ b/pygmt/datasets/earth_magnetic_anomaly.py @@ -16,7 +16,9 @@ @kwargs_to_strings(region="sequence") def load_earth_magnetic_anomaly( - resolution="01d", + resolution: Literal[ + "01d", "30m", "20m", "15m", "10m", "06m", "05m", "04m", "03m", "02m" + ] = "01d", region=None, registration: Literal["gridline", "pixel", None] = None, data_source: Literal["emag2", "emag2_4km", "wdmam"] = "emag2", @@ -64,11 +66,9 @@ def load_earth_magnetic_anomaly( Parameters ---------- - resolution : str - The grid resolution. The suffix ``d`` and ``m`` stand for - arc-degrees and arc-minutes. It can be ``"01d"``, ``"30m"``, - ``"20m"``, ``"15m"``, ``"10m"``, ``"06m"``, ``"05m"``, ``"04m"``, - ``"03m"``, or ``"02m"``. The ``"02m"`` resolution is not available for + resolution + The grid resolution. The suffix ``d`` and ``m`` stand for arc-degrees and + arc-minutes. The resolution ``"02m"`` is not available for ``data_source="wdmam"``. region : str or list diff --git a/pygmt/datasets/earth_mask.py b/pygmt/datasets/earth_mask.py index 53ef5ecb29d..b2c9ef40b5c 100644 --- a/pygmt/datasets/earth_mask.py +++ b/pygmt/datasets/earth_mask.py @@ -15,7 +15,21 @@ @kwargs_to_strings(region="sequence") def load_earth_mask( - resolution="01d", + resolution: Literal[ + "01d", + "30m", + "20m", + "15m", + "10m", + "06m", + "05m", + "04m", + "03m", + "02m", + "01m", + "30s", + "15s", + ] = "01d", region=None, registration: Literal["gridline", "pixel"] = "gridline", ): @@ -44,11 +58,9 @@ def load_earth_mask( Parameters ---------- - resolution : str - The grid resolution. The suffix ``d``, ``m``, and ``s`` stand for - arc-degrees, arc-minutes, and arc-seconds. It can be ``"01d"``, - ``"30m"``, ``"20m"``, ``"15m"``, ``"10m"``, ``"06m"``, ``"05m"``, - ``"04m"``, ``"03m"``, ``"02m"``, ``"01m"``, ``"30s"``, or ``"15s"``. + resolution + The grid resolution. The suffix ``d``, ``m``, and ``s`` stand for arc-degrees, + arc-minutes, and arc-seconds. region : str or list The subregion of the grid to load, in the form of a list diff --git a/pygmt/datasets/earth_relief.py b/pygmt/datasets/earth_relief.py index 38461137e7c..969e3d89b60 100644 --- a/pygmt/datasets/earth_relief.py +++ b/pygmt/datasets/earth_relief.py @@ -16,7 +16,23 @@ @kwargs_to_strings(region="sequence") def load_earth_relief( - resolution="01d", + resolution: Literal[ + "01d", + "30m", + "20m", + "15m", + "10m", + "06m", + "05m", + "04m", + "03m", + "02m", + "01m", + "30s", + "15s", + "03s", + "01s", + ] = "01d", region=None, registration: Literal["gridline", "pixel", None] = None, data_source: Literal["igpp", "gebco", "gebcosi", "synbath"] = "igpp", @@ -58,12 +74,9 @@ def load_earth_relief( Parameters ---------- - resolution : str - The grid resolution. The suffix ``d``, ``m`` and ``s`` stand for - arc-degrees, arc-minutes, and arc-seconds. It can be ``"01d"``, - ``"30m"``, ``"20m"``, ``"15m"``, ``"10m"``, ``"06m"``, ``"05m"``, - ``"04m"``, ``"03m"``, ``"02m"``, ``"01m"``, ``"30s"``, ``"15s"``, - ``"03s"``, or ``"01s"``. + resolution + The grid resolution. The suffix ``d``, ``m`` and ``s`` stand for arc-degrees, + arc-minutes, and arc-seconds. region : str or list The subregion of the grid to load, in the form of a list diff --git a/pygmt/datasets/earth_vertical_gravity_gradient.py b/pygmt/datasets/earth_vertical_gravity_gradient.py index 502f3eec913..86ef5be5550 100644 --- a/pygmt/datasets/earth_vertical_gravity_gradient.py +++ b/pygmt/datasets/earth_vertical_gravity_gradient.py @@ -15,7 +15,9 @@ @kwargs_to_strings(region="sequence") def load_earth_vertical_gravity_gradient( - resolution="01d", + resolution: Literal[ + "01d", "30m", "20m", "15m", "10m", "06m", "05m", "04m", "03m", "02m", "01m" + ] = "01d", region=None, registration: Literal["gridline", "pixel", None] = None, ): @@ -51,11 +53,9 @@ def load_earth_vertical_gravity_gradient( Parameters ---------- - resolution : str - The grid resolution. The suffix ``d`` and ``m`` stand for - arc-degrees and arc-minutes. It can be ``"01d"``, ``"30m"``, - ``"20m"``, ``"15m"``, ``"10m"``, ``"06m"``, ``"05m"``, ``"04m"``, - ``"03m"``, ``"02m"``, or ``"01m"``. + resolution + The grid resolution. The suffix ``d`` and ``m`` stand for arc-degrees and + arc-minutes. region : str or list The subregion of the grid to load, in the form of a list diff --git a/pygmt/datasets/mars_relief.py b/pygmt/datasets/mars_relief.py index 750d8bdbaa5..b7ffb8971cb 100644 --- a/pygmt/datasets/mars_relief.py +++ b/pygmt/datasets/mars_relief.py @@ -15,7 +15,22 @@ @kwargs_to_strings(region="sequence") def load_mars_relief( - resolution="01d", + resolution: Literal[ + "01d", + "30m", + "20m", + "15m", + "10m", + "06m", + "05m", + "04m", + "03m", + "02m", + "01m", + "30s", + "15s", + "12s", + ] = "01d", region=None, registration: Literal["gridline", "pixel", None] = None, ): @@ -50,11 +65,9 @@ def load_mars_relief( Parameters ---------- - resolution : str + resolution The grid resolution. The suffix ``d``, ``m`` and ``s`` stand for arc-degrees, - arc-minutes and arc-seconds. It can be ``"01d"``, ``"30m"``, ``"20m"``, - ``"15m"``, ``"10m"``, ``"06m"``, ``"05m"``, ``"04m"``, ``"03m"``, ``"02m"``, - ``"01m"``, ``"30s"``, ``"15s"``, and ``"12s"``. + arc-minutes and arc-seconds. region : str or list The subregion of the grid to load, in the form of a list [*xmin*, *xmax*, *ymin*, *ymax*] or a string *xmin/xmax/ymin/ymax*. Required for diff --git a/pygmt/datasets/mercury_relief.py b/pygmt/datasets/mercury_relief.py index ee753f8a7a0..4764408c7ef 100644 --- a/pygmt/datasets/mercury_relief.py +++ b/pygmt/datasets/mercury_relief.py @@ -15,7 +15,20 @@ @kwargs_to_strings(region="sequence") def load_mercury_relief( - resolution="01d", + resolution: Literal[ + "01d", + "30m", + "20m", + "15m", + "10m", + "06m", + "05m", + "04m", + "03m", + "02m", + "01m", + "56s", + ] = "01d", region=None, registration: Literal["gridline", "pixel", None] = None, ): @@ -50,11 +63,9 @@ def load_mercury_relief( Parameters ---------- - resolution : str + resolution The grid resolution. The suffix ``d``, ``m`` and ``s`` stand for arc-degrees, - arc-minutes and arc-seconds. It can be ``"01d"``, ``"30m"``, ``"20m"``, - ``"15m"``, ``"10m"``, ``"06m"``, ``"05m"``, ``"04m"``, ``"03m"``, ``"02m"``, - ``"01m"``, and ``"56s"``. + arc-minutes and arc-seconds. region : str or list The subregion of the grid to load, in the form of a list [*xmin*, *xmax*, *ymin*, *ymax*] or a string *xmin/xmax/ymin/ymax*. Required for diff --git a/pygmt/datasets/moon_relief.py b/pygmt/datasets/moon_relief.py index 522632476bb..22809f6a281 100644 --- a/pygmt/datasets/moon_relief.py +++ b/pygmt/datasets/moon_relief.py @@ -15,7 +15,22 @@ @kwargs_to_strings(region="sequence") def load_moon_relief( - resolution="01d", + resolution: Literal[ + "01d", + "30m", + "20m", + "15m", + "10m", + "06m", + "05m", + "04m", + "03m", + "02m", + "01m", + "30s", + "15s", + "14s", + ] = "01d", region=None, registration: Literal["gridline", "pixel", None] = None, ): @@ -50,11 +65,9 @@ def load_moon_relief( Parameters ---------- - resolution : str + resolution The grid resolution. The suffix ``d``, ``m`` and ``s`` stand for arc-degrees, - arc-minutes and arc-seconds. It can be ``"01d"``, ``"30m"``, ``"20m"``, - ``"15m"``, ``"10m"``, ``"06m"``, ``"05m"``, ``"04m"``, ``"03m"``, ``"02m"``, - ``"01m"``, ``"30s"``, ``"15s"``, and ``"14s"``. + arc-minutes and arc-seconds. region : str or list The subregion of the grid to load, in the form of a list [*xmin*, *xmax*, *ymin*, *ymax*] or a string *xmin/xmax/ymin/ymax*. Required for diff --git a/pygmt/datasets/pluto_relief.py b/pygmt/datasets/pluto_relief.py index b3cc7a428c9..1b25ac910ea 100644 --- a/pygmt/datasets/pluto_relief.py +++ b/pygmt/datasets/pluto_relief.py @@ -15,7 +15,20 @@ @kwargs_to_strings(region="sequence") def load_pluto_relief( - resolution="01d", + resolution: Literal[ + "01d", + "30m", + "20m", + "15m", + "10m", + "06m", + "05m", + "04m", + "03m", + "02m", + "01m", + "52s", + ] = "01d", region=None, registration: Literal["gridline", "pixel", None] = None, ): @@ -50,11 +63,9 @@ def load_pluto_relief( Parameters ---------- - resolution : str + resolution The grid resolution. The suffix ``d``, ``m`` and ``s`` stand for arc-degrees, - arc-minutes and arc-seconds. It can be ``"01d"``, ``"30m"``, ``"20m"``, - ``"15m"``, ``"10m"``, ``"06m"``, ``"05m"``, ``"04m"``, ``"03m"``, ``"02m"``, - ``"01m"``, and ``"52s"``. + arc-minutes and arc-seconds. region : str or list The subregion of the grid to load, in the form of a list [*xmin*, *xmax*, *ymin*, *ymax*] or a string *xmin/xmax/ymin/ymax*. Required for diff --git a/pygmt/datasets/venus_relief.py b/pygmt/datasets/venus_relief.py index 172d9e2a588..e86eed40d95 100644 --- a/pygmt/datasets/venus_relief.py +++ b/pygmt/datasets/venus_relief.py @@ -15,7 +15,9 @@ @kwargs_to_strings(region="sequence") def load_venus_relief( - resolution="01d", + resolution: Literal[ + "01d", "30m", "20m", "15m", "10m", "06m", "05m", "04m", "03m", "02m", "01m" + ] = "01d", region=None, registration: Literal["gridline", "pixel"] = "gridline", ): @@ -50,10 +52,9 @@ def load_venus_relief( Parameters ---------- - resolution : str + resolution The grid resolution. The suffix ``d`` and ``m`` stand for arc-degrees and - arc-minutes. It can be ``"01d"``, ``"30m"``, ``"20m"``, ``"15m"``, ``"10m"``, - ``"06m"``, ``"05m"``, ``"04m"``, ``"03m"``, ``"02m"``, and ``"01m"``. + arc-minutes. region : str or list The subregion of the grid to load, in the form of a list [*xmin*, *xmax*, *ymin*, *ymax*] or a string *xmin/xmax/ymin/ymax*.