diff --git a/doc/changes.md b/doc/changes.md index b8c5c6f6faf..36beaf8327a 100644 --- a/doc/changes.md +++ b/doc/changes.md @@ -1676,7 +1676,7 @@ Andrés Ignacio Torres, * Add authorship policy ([#726](https://github.com/GenericMappingTools/pygmt/pull/726)) * Update PyGMT development installation instructions ([#865](https://github.com/GenericMappingTools/pygmt/pull/865)) * Add a tutorial for adding a map title ([#720](https://github.com/GenericMappingTools/pygmt/pull/720)) -* Add a tutorial for plotting Earth relief ([#712](https://github.com/GenericMappingTools/pygmt/pull/712)) +* Add a tutorial for plotting Earth's relief ([#712](https://github.com/GenericMappingTools/pygmt/pull/712)) * Add a tutorial for 3D perspective image ([#743](https://github.com/GenericMappingTools/pygmt/pull/743)) * Add a tutorial for contour maps ([#705](https://github.com/GenericMappingTools/pygmt/pull/705)) * Add a tutorial for plotting lines ([#741](https://github.com/GenericMappingTools/pygmt/pull/741)) @@ -1918,11 +1918,11 @@ Andrés Ignacio Torres, ### Maintenance * Temporarily expect failures for some grdcontour and grdview tests ([#503](https://github.com/GenericMappingTools/pygmt/pull/503)) -* Fix several failures due to updates of earth relief data ([#498](https://github.com/GenericMappingTools/pygmt/pull/498)) +* Fix several failures due to updates of Earth's relief data ([#498](https://github.com/GenericMappingTools/pygmt/pull/498)) * Unpin pylint version and fix some lint warnings ([#484](https://github.com/GenericMappingTools/pygmt/pull/484)) * Separate tests of gmtinfo and grdinfo ([#461](https://github.com/GenericMappingTools/pygmt/pull/461)) * Fix the test for GMT_COMPATIBILITY=6 ([#454](https://github.com/GenericMappingTools/pygmt/pull/454)) -* Update baseline images for updates of earth relief data ([#452](https://github.com/GenericMappingTools/pygmt/pull/452)) +* Update baseline images for updates of Earth's relief data ([#452](https://github.com/GenericMappingTools/pygmt/pull/452)) * Simplify PyGMT Release process ([#446](https://github.com/GenericMappingTools/pygmt/pull/446)) **Contributors**: @@ -2027,7 +2027,7 @@ Andrés Ignacio Torres, * Quickfix Zeit Now miniconda installer link to anaconda.com ([#413](https://github.com/GenericMappingTools/pygmt/pull/413)) * Fix GitHub Pages deployment from Travis ([#410](https://github.com/GenericMappingTools/pygmt/pull/410)) * Update and clean TravisCI configuration ([#404](https://github.com/GenericMappingTools/pygmt/pull/404)) -* Quickfix min elevation for new SRTM15+V2.1 earth relief grids ([#401](https://github.com/GenericMappingTools/pygmt/pull/401)) +* Quickfix min elevation for new SRTM15+V2.1 Earth's relief grids ([#401](https://github.com/GenericMappingTools/pygmt/pull/401)) * Wrap docstrings to 79 chars and check with flake8 ([#384](https://github.com/GenericMappingTools/pygmt/pull/384)) * Update continuous integration scripts to 1.2.0 ([#355](https://github.com/GenericMappingTools/pygmt/pull/355)) * Use Zeit Now to deploy doc builds from PRs ([#344](https://github.com/GenericMappingTools/pygmt/pull/344)) diff --git a/examples/gallery/images/track_sampling.py b/examples/gallery/images/track_sampling.py index f1681cd9e7d..d496ae6337f 100644 --- a/examples/gallery/images/track_sampling.py +++ b/examples/gallery/images/track_sampling.py @@ -26,7 +26,7 @@ track = pygmt.grdtrack(points=points, grid=grid, newcolname="bathymetry") fig = pygmt.Figure() -# Plot the earth relief grid on Cylindrical Stereographic projection, masking +# Plot Earth's relief grid on Cylindrical Stereographic projection, masking # land areas fig.basemap(region="g", projection="Cyl_stere/150/-20/15c", frame=True) fig.grdimage(grid=grid, cmap="gmt/gray") diff --git a/examples/tutorials/advanced/3d_perspective_image.py b/examples/tutorials/advanced/3d_perspective_image.py index 0dc70274028..d08c40b81db 100644 --- a/examples/tutorials/advanced/3d_perspective_image.py +++ b/examples/tutorials/advanced/3d_perspective_image.py @@ -10,7 +10,7 @@ import pygmt from pygmt.params import Axis, Frame -# Load sample earth relief data +# Load sample Earth's relief data grid = pygmt.datasets.load_earth_relief(resolution="10m", region=[-108, -103, 35, 40]) # %% diff --git a/examples/tutorials/advanced/contour_map.py b/examples/tutorials/advanced/contour_map.py index 76b8f515454..27d52bf7b25 100644 --- a/examples/tutorials/advanced/contour_map.py +++ b/examples/tutorials/advanced/contour_map.py @@ -8,7 +8,7 @@ # %% import pygmt -# Load sample earth relief data +# Load sample Earth's relief data grid = pygmt.datasets.load_earth_relief(resolution="05m", region=[-92.5, -82.5, -3, 7]) diff --git a/examples/tutorials/advanced/working_with_panel.py b/examples/tutorials/advanced/working_with_panel.py index 8d450b3a17b..c6556ac90cc 100644 --- a/examples/tutorials/advanced/working_with_panel.py +++ b/examples/tutorials/advanced/working_with_panel.py @@ -17,7 +17,7 @@ - Make a static map - Make an interactive map -- Add a grid for Earth relief +- Add a grid for Earth's relief """ # %% @@ -36,7 +36,7 @@ # # The `Orthographic projection # `__ -# can be used to show the Earth as a globe. Land and water masses are +# can be used to show Earth as a globe. Land and water masses are # filled with colors via the ``land`` and ``water`` parameters of # :meth:`pygmt.Figure.coast`, respectively. Coastlines are added using the # ``shorelines`` parameter. @@ -61,7 +61,7 @@ # Make an interactive map # ----------------------- # -# To generate a rotation of the Earth around the vertical axis, the central +# To generate a rotation of Earth around the vertical axis, the central # longitude of the Orthographic projection is varied iteratively in steps of # 10 degrees. The library ``Panel`` is used to create an interactive dashboard # with a slider (works only in a notebook environment, e.g., Jupyter notebook). @@ -98,13 +98,13 @@ def view(central_lon): # %% -# Add a grid for Earth relief -# --------------------------- +# Add a grid for Earth's relief +# ----------------------------- # # Instead of using colors as fill for the land and water masses a grid can be -# displayed. Here, the Earth relief is shown by color-coding the elevation. +# displayed. Here, Earth's relief is shown by color-coding the elevation. -# Download a grid for Earth relief with a resolution of 10 arc-minutes +# Download a grid for Earth's relief with a resolution of 10 arc-minutes grd_relief = pygmt.datasets.load_earth_relief(resolution="10m") # Create a slider diff --git a/pygmt/datasets/earth_age.py b/pygmt/datasets/earth_age.py index 39b8bee707d..444b86f8bcb 100644 --- a/pygmt/datasets/earth_age.py +++ b/pygmt/datasets/earth_age.py @@ -1,5 +1,5 @@ """ -Function to download the Earth seafloor crustal age dataset from the GMT data server, +Function to download Earth's seafloor crustal age dataset from the GMT data server, and load as :class:`xarray.DataArray`. The grids are available in various resolutions. @@ -22,13 +22,13 @@ def load_earth_age( registration: Literal["gridline", "pixel"] = "gridline", ) -> xr.DataArray: r""" - Load the Earth seafloor crustal age dataset in various resolutions. + Load Earth's seafloor crustal age dataset in various resolutions. .. figure:: https://www.generic-mapping-tools.org/remote-datasets/_images/GMT_earth_age.jpg :width: 80 % :align: center - Earth seafloor crustal age dataset. + Earth's seafloor crustal age dataset. This function downloads the dataset from the GMT data server, caches it in a user data directory (usually ``~/.gmt/server/earth/earth_age/``), and load the dataset as @@ -70,7 +70,7 @@ def load_earth_age( Returns ------- grid - The Earth seafloor crustal age grid. Coordinates are latitude and longitude in + Earth's seafloor crustal age grid. Coordinates are latitude and longitude in degrees. Age is in millions of years (Myr). Note diff --git a/pygmt/datasets/earth_dist.py b/pygmt/datasets/earth_dist.py index 1e1f16d1df8..1239e9b670f 100644 --- a/pygmt/datasets/earth_dist.py +++ b/pygmt/datasets/earth_dist.py @@ -1,5 +1,5 @@ """ -Function to download the GSHHG Earth distance to shoreline dataset from the GMT data +Function to download the GSHHG Earth's distance to shoreline dataset from the GMT data server, and load as :class:`xarray.DataArray`. The grids are available in various resolutions. @@ -22,13 +22,13 @@ def load_earth_dist( registration: Literal["gridline", "pixel"] = "gridline", ) -> xr.DataArray: r""" - Load the GSHHG Earth distance to shoreline dataset in various resolutions. + Load the GSHHG Earth's distance to shoreline dataset in various resolutions. .. figure:: https://www.generic-mapping-tools.org/remote-datasets/_images/GMT_earth_dist.jpg :width: 80 % :align: center - GSHHG Earth distance to shoreline dataset. + GSHHG Earth's distance to shoreline dataset. This function downloads the dataset from the GMT data server, caches it in a user data directory (usually ``~/.gmt/server/earth/earth_dist/``), and load the dataset @@ -70,7 +70,7 @@ def load_earth_dist( Returns ------- grid - The GSHHG Earth distance to shoreline grid. Coordinates are latitude and + The GSHHG Earth's distance to shoreline grid. Coordinates are latitude and longitude in degrees. Distances are in kilometers, where positive (negative) values mean land to coastline (ocean to coastline). diff --git a/pygmt/datasets/earth_free_air_anomaly.py b/pygmt/datasets/earth_free_air_anomaly.py index 988e3d60960..38153d5fa1a 100644 --- a/pygmt/datasets/earth_free_air_anomaly.py +++ b/pygmt/datasets/earth_free_air_anomaly.py @@ -1,5 +1,5 @@ """ -Function to download the IGPP Earth free-air anomaly and uncertainty datasets from +Function to download the IGPP Earth's free-air anomaly and uncertainty datasets from the GMT data server, and load as :class:`xarray.DataArray`. The grids are available in various resolutions. @@ -23,15 +23,15 @@ def load_earth_free_air_anomaly( uncertainty: bool = False, ) -> xr.DataArray: r""" - Load the IGPP Earth free-air anomaly and uncertainty datasets in various + Load the IGPP Earth's free-air anomaly and uncertainty datasets in various resolutions. .. list-table:: :widths: 50 50 :header-rows: 1 - * - IGPP Earth free-air anomaly - - IGPP Earth free-air anomaly uncertainty + * - IGPP Earth's free-air anomaly + - IGPP Earth's free-air anomaly uncertainty * - .. figure:: https://www.generic-mapping-tools.org/remote-datasets/_images/GMT_earth_faa.jpg - .. figure:: https://www.generic-mapping-tools.org/remote-datasets/_images/GMT_earth_faaerror.jpg @@ -78,13 +78,13 @@ def load_earth_free_air_anomaly( ``"gridline"`` for all resolutions except ``"01m"`` which is ``"pixel"`` only. uncertainty - By default, the Earth free-air anomaly values are returned. Set to ``True`` to + By default, Earth's free-air anomaly values are returned. Set to ``True`` to return the related uncertainties instead. Returns ------- grid - The Earth free-air anomaly (uncertainty) grid. Coordinates are latitude and + Earth's free-air anomaly (uncertainty) grid. Coordinates are latitude and longitude in degrees. Values and uncertainties are in mGal. Note diff --git a/pygmt/datasets/earth_geoid.py b/pygmt/datasets/earth_geoid.py index 50cce3fe629..8f846ba100c 100644 --- a/pygmt/datasets/earth_geoid.py +++ b/pygmt/datasets/earth_geoid.py @@ -1,6 +1,6 @@ """ -Function to download the EGM2008 Earth geoid dataset from the GMT data server, and load -as :class:`xarray.DataArray`. +Function to download the EGM2008 Earth's geoid dataset from the GMT data server, and +load as :class:`xarray.DataArray`. The grids are available in various resolutions. """ @@ -22,13 +22,13 @@ def load_earth_geoid( registration: Literal["gridline", "pixel"] = "gridline", ) -> xr.DataArray: r""" - Load the EGM2008 Earth geoid dataset in various resolutions. + Load the EGM2008 Earth's geoid dataset in various resolutions. .. figure:: https://www.generic-mapping-tools.org/remote-datasets/_images/GMT_earth_geoid.jpg :width: 80 % :align: center - EGM2008 Earth geoid dataset. + EGM2008 Earth's geoid dataset. This function downloads the dataset from the GMT data server, caches it in a user data directory (usually ``~/.gmt/server/earth/earth_geoid/``), and load the dataset @@ -64,7 +64,7 @@ def load_earth_geoid( Returns ------- grid - The Earth geoid grid. Coordinates are latitude and + Earth's geoid grid. Coordinates are latitude and longitude in degrees. Units are in meters. Note diff --git a/pygmt/datasets/earth_magnetic_anomaly.py b/pygmt/datasets/earth_magnetic_anomaly.py index 5f68602b5d4..a052ae6f912 100644 --- a/pygmt/datasets/earth_magnetic_anomaly.py +++ b/pygmt/datasets/earth_magnetic_anomaly.py @@ -1,5 +1,5 @@ """ -Function to download the Earth magnetic anomaly datasets from the GMT data server, and +Function to download Earth's magnetic anomaly datasets from the GMT data server, and load as :class:`xarray.DataArray`. The grids are available in various resolutions. @@ -24,7 +24,7 @@ def load_earth_magnetic_anomaly( data_source: Literal["emag2", "emag2_4km", "wdmam"] = "emag2", ) -> xr.DataArray: r""" - Load the Earth magnetic anomaly datasets in various resolutions. + Load Earth's magnetic anomaly datasets in various resolutions. .. list-table:: :widths: 50 50 @@ -96,7 +96,7 @@ def load_earth_magnetic_anomaly( Returns ------- grid - The Earth magnetic anomaly grid. Coordinates are latitude and + Earth's magnetic anomaly grid. Coordinates are latitude and longitude in degrees. Units are in nano Tesla (nT). Note diff --git a/pygmt/datasets/earth_mask.py b/pygmt/datasets/earth_mask.py index ca1986fc6ae..911afe4cba2 100644 --- a/pygmt/datasets/earth_mask.py +++ b/pygmt/datasets/earth_mask.py @@ -1,6 +1,6 @@ """ -Function to download the GSHHG Earth Mask dataset from the GMT data server, and load as -:class:`xarray.DataArray`. +Function to download the GSHHG Earth's mask dataset from the GMT data server, and load +as :class:`xarray.DataArray`. The grids are available in various resolutions. """ @@ -34,13 +34,13 @@ def load_earth_mask( registration: Literal["gridline", "pixel"] = "gridline", ) -> xr.DataArray: r""" - Load the GSHHG Earth mask dataset in various resolutions. + Load the GSHHG Earth's mask dataset in various resolutions. .. figure:: https://www.generic-mapping-tools.org/remote-datasets/_images/GMT_earth_mask.jpg :width: 80 % :align: center - GSHHG Earth mask dataset. + GSHHG Earth's mask dataset. This function downloads the dataset from the GMT data server, caches it in a user data directory (usually ``~/.gmt/server/earth/earth_mask/``), and load the dataset @@ -75,7 +75,7 @@ def load_earth_mask( Returns ------- grid - The Earth mask grid. Coordinates are latitude and + Earth's mask grid. Coordinates are latitude and longitude in degrees. The node values in the mask grids are all in the 0-4 range and reflect different surface types: diff --git a/pygmt/datasets/earth_mean_dynamic_topography.py b/pygmt/datasets/earth_mean_dynamic_topography.py index 354f011748a..d1a7585b4ab 100644 --- a/pygmt/datasets/earth_mean_dynamic_topography.py +++ b/pygmt/datasets/earth_mean_dynamic_topography.py @@ -1,5 +1,5 @@ """ -Function to download the CNES Earth mean dynamic topography dataset from the GMT data +Function to download the CNES Earth's mean dynamic topography dataset from the GMT data server, and load as :class:`xarray.DataArray`. The grids are available in various resolutions. @@ -20,13 +20,13 @@ def load_earth_mean_dynamic_topography( registration: Literal["gridline", "pixel"] = "gridline", ) -> xr.DataArray: r""" - Load the CNES Earth mean dynamic topography dataset in various resolutions. + Load the CNES Earth's mean dynamic topography dataset in various resolutions. .. figure:: https://www.generic-mapping-tools.org/remote-datasets/_images/GMT_earth_mdt.jpg :width: 80 % :align: center - CNES Earth mean dynamic topography dataset. + CNES Earth's mean dynamic topography dataset. This function downloads the dataset from the GMT data server, caches it in a user data directory (usually ``~/.gmt/server/earth/earth_mdt/``), and load the dataset as @@ -67,7 +67,7 @@ def load_earth_mean_dynamic_topography( Returns ------- grid - The CNES Earth mean dynamic topography grid. Coordinates are latitude and + CNES Earth's mean dynamic topography grid. Coordinates are latitude and longitude in degrees. Values are in meters. Note diff --git a/pygmt/datasets/earth_mean_sea_surface.py b/pygmt/datasets/earth_mean_sea_surface.py index b064246ecab..f1038351442 100644 --- a/pygmt/datasets/earth_mean_sea_surface.py +++ b/pygmt/datasets/earth_mean_sea_surface.py @@ -1,5 +1,5 @@ """ -Function to download the CNES Earth mean sea surface dataset from the GMT data +Function to download the CNES Earth's mean sea surface dataset from the GMT data server, and load as :class:`xarray.DataArray`. The grids are available in various resolutions. @@ -22,13 +22,13 @@ def load_earth_mean_sea_surface( registration: Literal["gridline", "pixel"] = "gridline", ) -> xr.DataArray: r""" - Load the CNES Earth mean sea surface dataset in various resolutions. + Load the CNES Earth's mean sea surface dataset in various resolutions. .. figure:: https://www.generic-mapping-tools.org/remote-datasets/_images/GMT_earth_mss.jpg :width: 80 % :align: center - CNES Earth mean sea surface dataset. + CNES Earth's mean sea surface dataset. This function downloads the dataset from the GMT data server, caches it in a user data directory (usually ``~/.gmt/server/earth/earth_mss/``), and load the dataset as @@ -70,7 +70,7 @@ def load_earth_mean_sea_surface( Returns ------- grid - The CNES Earth mean sea surface grid. Coordinates are latitude and + CNES Earth's mean sea surface grid. Coordinates are latitude and longitude in degrees. Values are in meters. Note diff --git a/pygmt/datasets/earth_night.py b/pygmt/datasets/earth_night.py index 059a5467ff0..7b6dba5095d 100644 --- a/pygmt/datasets/earth_night.py +++ b/pygmt/datasets/earth_night.py @@ -38,7 +38,7 @@ def load_black_marble( :width: 80% :align: center - Earth day/night dataset. + Earth's day/night dataset. This function downloads the dataset from the GMT data server, caches it in a user data directory (usually ``~/.gmt/server/earth/earth_night/``), and load the dataset diff --git a/pygmt/datasets/earth_relief.py b/pygmt/datasets/earth_relief.py index d4a1ce38267..aba476b0f20 100644 --- a/pygmt/datasets/earth_relief.py +++ b/pygmt/datasets/earth_relief.py @@ -1,5 +1,5 @@ """ -Function to download the Earth relief datasets from the GMT data server, and load as +Function to download Earth's relief datasets from the GMT data server, and load as :class:`xarray.DataArray`. The grids are available in various resolutions. @@ -39,13 +39,13 @@ def load_earth_relief( use_srtm: bool = False, ) -> xr.DataArray: r""" - Load the Earth relief datasets (topography and bathymetry) in various resolutions. + Load Earth's relief datasets (topography and bathymetry) in various resolutions. .. figure:: https://www.generic-mapping-tools.org/remote-datasets/_images/GMT_earth_gebco.jpg :width: 80 % :align: center - Earth relief datasets (topography and bathymetry). + Earth's relief datasets (topography and bathymetry). This function downloads the dataset from the GMT data server, caches it in a user data directory (usually ``~/.gmt/server/earth/earth_relief``, @@ -89,7 +89,7 @@ def load_earth_relief( ``"gridline"`` for gridline registration. Default is ``None``, which means ``"gridline"`` for all resolutions except ``"15s"`` which is ``"pixel"`` only. data_source - Select the source for the Earth relief data. Available options are: + Select the source for Earth's relief datasets. Available options are: - ``"igpp"``: IGPP Earth Relief. See :gmt-datasets:`earth-relief.html`. - ``"synbath"``: IGPP Earth Relief dataset that uses statistical properties of @@ -111,7 +111,7 @@ def load_earth_relief( Returns ------- grid - The Earth relief grid. Coordinates are latitude and longitude in degrees. Relief + Earth's relief grid. Coordinates are latitude and longitude in degrees. Relief is in meters. Note @@ -169,7 +169,7 @@ def load_earth_relief( if use_srtm and resolution in srtm_resolutions: prefix = "srtm_relief" - # Choose earth relief dataset name. + # Choose Earth's relief dataset name. match data_source: case "igpp" | "synbath": name = "earth_igpp" diff --git a/pygmt/datasets/earth_vertical_gravity_gradient.py b/pygmt/datasets/earth_vertical_gravity_gradient.py index 04b4d1cccb5..a92f2209e93 100644 --- a/pygmt/datasets/earth_vertical_gravity_gradient.py +++ b/pygmt/datasets/earth_vertical_gravity_gradient.py @@ -1,6 +1,6 @@ """ -Function to download the IGPP Earth vertical gravity gradient dataset from the GMT data -server, and load as :class:`xarray.DataArray`. +Function to download the IGPP Earth's vertical gravity gradient dataset from the GMT +data server, and load as :class:`xarray.DataArray`. The grids are available in various resolutions. """ @@ -22,13 +22,13 @@ def load_earth_vertical_gravity_gradient( registration: Literal["gridline", "pixel", None] = None, ) -> xr.DataArray: r""" - Load the IGPP Earth vertical gravity gradient dataset in various resolutions. + Load the IGPP Earth's vertical gravity gradient dataset in various resolutions. .. figure:: https://www.generic-mapping-tools.org/remote-datasets/_images/GMT_earth_vgg.jpg :width: 80 % :align: center - IGPP Earth vertical gravity gradient dataset. + IGPP Earth's vertical gravity gradient dataset. This function downloads the dataset from the GMT data server, caches it in a user data directory (usually ``~/.gmt/server/earth/earth_vgg/``), and load the dataset as @@ -72,7 +72,7 @@ def load_earth_vertical_gravity_gradient( Returns ------- grid - The Earth vertical gravity gradient grid. Coordinates are latitude and + Earth's vertical gravity gradient grid. Coordinates are latitude and longitude in degrees. Units are in Eotvos. Note diff --git a/pygmt/datasets/mars_relief.py b/pygmt/datasets/mars_relief.py index 318ff8367fc..ad0c1cb238d 100644 --- a/pygmt/datasets/mars_relief.py +++ b/pygmt/datasets/mars_relief.py @@ -1,5 +1,5 @@ """ -Function to download the Mars relief dataset from the GMT data server, and load as +Function to download Mars' relief dataset from the GMT data server, and load as :class:`xarray.DataArray`. The grids are available in various resolutions. @@ -35,13 +35,13 @@ def load_mars_relief( registration: Literal["gridline", "pixel", None] = None, ) -> xr.DataArray: r""" - Load the Mars relief dataset in various resolutions. + Load Mars' relief dataset in various resolutions. .. figure:: https://www.generic-mapping-tools.org/remote-datasets/_images/GMT_mars_relief.jpg :width: 80% :align: center - Mars relief dataset. + Mars' relief dataset. This function downloads the dataset from the GMT data server, caches it in a user data directory (usually ``~/.gmt/server/mars/mars_relief/``), and load the dataset @@ -86,7 +86,7 @@ def load_mars_relief( Returns ------- grid - The Mars relief grid. Coordinates are latitude and longitude in degrees. Relief + Mars' relief grid. Coordinates are latitude and longitude in degrees. Relief is in meters. Note diff --git a/pygmt/datasets/mercury_relief.py b/pygmt/datasets/mercury_relief.py index bad94cafe6d..20b3c73ff77 100644 --- a/pygmt/datasets/mercury_relief.py +++ b/pygmt/datasets/mercury_relief.py @@ -1,5 +1,5 @@ """ -Function to download the Mercury relief dataset from the GMT data server, and load as +Function to download Mercury's relief dataset from the GMT data server, and load as :class:`xarray.DataArray`. The grids are available in various resolutions. @@ -33,13 +33,13 @@ def load_mercury_relief( registration: Literal["gridline", "pixel", None] = None, ) -> xr.DataArray: r""" - Load the Mercury relief dataset in various resolutions. + Load Mercury's relief dataset in various resolutions. .. figure:: https://www.generic-mapping-tools.org/remote-datasets/_images/GMT_mercury_relief.jpg :width: 80% :align: center - Mercury relief dataset. + Mercury's relief dataset. This function downloads the dataset from the GMT data server, caches it in a user data directory (usually ``~/.gmt/server/mercury/mercury_relief/``), and load the @@ -85,7 +85,7 @@ def load_mercury_relief( Returns ------- grid - The Mercury relief grid. Coordinates are latitude and longitude in degrees. + Mercury's relief grid. Coordinates are latitude and longitude in degrees. Relief is in meters. Note diff --git a/pygmt/datasets/moon_relief.py b/pygmt/datasets/moon_relief.py index 2a440f9600a..bd993333dc2 100644 --- a/pygmt/datasets/moon_relief.py +++ b/pygmt/datasets/moon_relief.py @@ -1,5 +1,5 @@ """ -Function to download the Moon relief dataset from the GMT data server, and load as +Function to download Moon's relief dataset from the GMT data server, and load as :class:`xarray.DataArray`. The grids are available in various resolutions. @@ -35,13 +35,13 @@ def load_moon_relief( registration: Literal["gridline", "pixel", None] = None, ) -> xr.DataArray: r""" - Load the Moon relief dataset in various resolutions. + Load Moon's relief dataset in various resolutions. .. figure:: https://www.generic-mapping-tools.org/remote-datasets/_images/GMT_moon_relief.jpg :width: 80% :align: center - Moon relief dataset. + Moon's relief dataset. This function downloads the dataset from the GMT data server, caches it in a user data directory (usually ``~/.gmt/server/moon/moon_relief/``), and load the dataset @@ -86,7 +86,7 @@ def load_moon_relief( Returns ------- grid - The Moon relief grid. Coordinates are latitude and longitude in degrees. Relief + Moon's relief grid. Coordinates are latitude and longitude in degrees. Relief is in meters. Note diff --git a/pygmt/datasets/pluto_relief.py b/pygmt/datasets/pluto_relief.py index 4eea2d7828e..da7ff16d809 100644 --- a/pygmt/datasets/pluto_relief.py +++ b/pygmt/datasets/pluto_relief.py @@ -1,5 +1,5 @@ """ -Function to download the Pluto relief dataset from the GMT data server, and load as +Function to download Pluto's relief dataset from the GMT data server, and load as :class:`xarray.DataArray`. The grids are available in various resolutions. @@ -33,13 +33,13 @@ def load_pluto_relief( registration: Literal["gridline", "pixel", None] = None, ) -> xr.DataArray: r""" - Load the Pluto relief dataset in various resolutions. + Load Pluto's relief dataset in various resolutions. .. figure:: https://www.generic-mapping-tools.org/remote-datasets/_images/GMT_pluto_relief.jpg :width: 80% :align: center - Pluto relief dataset. + Pluto's relief dataset. This function downloads the dataset from the GMT data server, caches it in a user data directory (usually ``~/.gmt/server/pluto/pluto_relief/``), and load the dataset @@ -85,7 +85,7 @@ def load_pluto_relief( Returns ------- grid - The Pluto relief grid. Coordinates are latitude and longitude in degrees. Relief + Pluto's relief grid. Coordinates are latitude and longitude in degrees. Relief is in meters. Note diff --git a/pygmt/datasets/samples.py b/pygmt/datasets/samples.py index 1623967a9b9..0b4dc57cf35 100644 --- a/pygmt/datasets/samples.py +++ b/pygmt/datasets/samples.py @@ -194,12 +194,12 @@ def _load_maunaloa_co2() -> pd.DataFrame: def _load_earth_relief_holes() -> xr.DataArray: """ - Load the earth relief grid with some holes. + Load Earth's relief grid with some holes. Returns ------- grid - The Earth relief grid. Coordinates are latitude and longitude in degrees. Relief + Earth's relief grid. Coordinates are latitude and longitude in degrees. Relief is in meters. """ fname = which("@earth_relief_20m_holes.grd", download="cache") diff --git a/pygmt/datasets/venus_relief.py b/pygmt/datasets/venus_relief.py index a83d5185018..91e25b59d9d 100644 --- a/pygmt/datasets/venus_relief.py +++ b/pygmt/datasets/venus_relief.py @@ -1,5 +1,5 @@ """ -Function to download the Venus relief dataset from the GMT data server, and load as +Function to download Venus' relief dataset from the GMT data server, and load as :class:`xarray.DataArray`. The grids are available in various resolutions. @@ -22,13 +22,13 @@ def load_venus_relief( registration: Literal["gridline", "pixel"] = "gridline", ) -> xr.DataArray: r""" - Load the Venus relief dataset in various resolutions. + Load Venus' relief dataset in various resolutions. .. figure:: https://www.generic-mapping-tools.org/remote-datasets/_images/GMT_venus_relief.jpg :width: 80% :align: center - Venus relief dataset. + Venus' relief dataset. This function downloads the dataset from the GMT data server, caches it in a user data directory (usually ``~/.gmt/server/venus/venus_relief/``), and load the dataset @@ -70,7 +70,7 @@ def load_venus_relief( Returns ------- grid - The Venus relief grid. Coordinates are latitude and longitude in degrees. Relief + Venus' relief grid. Coordinates are latitude and longitude in degrees. Relief is in meters. Note diff --git a/pygmt/helpers/caching.py b/pygmt/helpers/caching.py index 5012f91b967..1a146aa2c47 100644 --- a/pygmt/helpers/caching.py +++ b/pygmt/helpers/caching.py @@ -126,7 +126,7 @@ def cache_data() -> None: "@hotspots.txt", "@mars370d.txt", "@ridge.txt", - "@srtm_tiles.nc", # Needed for earth relief 03s and 01s data. + "@srtm_tiles.nc", # Needed for Earth's relief 03s and 01s data. "@static_earth_relief.nc", "@ternary.txt", "@test.dat.nc", diff --git a/pygmt/src/grdview.py b/pygmt/src/grdview.py index 1cb65dd764f..360df6d9ebb 100644 --- a/pygmt/src/grdview.py +++ b/pygmt/src/grdview.py @@ -255,7 +255,7 @@ def grdview( Examples -------- - Create a 3-D surface plot of the Earth's relief. + Create a 3-D surface plot of Earth's relief. >>> import pygmt >>> from pygmt.params import Axis, Frame diff --git a/pygmt/tests/test_datasets_earth_age.py b/pygmt/tests/test_datasets_earth_age.py index 4074fa07004..ada1b9c12c1 100644 --- a/pygmt/tests/test_datasets_earth_age.py +++ b/pygmt/tests/test_datasets_earth_age.py @@ -1,5 +1,5 @@ """ -Test basic functionality for loading Earth seafloor crust age datasets. +Test basic functionality for loading Earth's seafloor crust age datasets. """ import numpy as np @@ -10,7 +10,7 @@ def test_earth_age_01d(): """ - Test some properties of the earth age 01d data. + Test some properties of Earth's age 01d data. """ data = load_earth_age(resolution="01d") assert data.name == "z" @@ -28,7 +28,7 @@ def test_earth_age_01d(): def test_earth_age_01d_with_region(): """ - Test loading low-resolution earth age with 'region'. + Test loading low-resolution Earth's age with 'region'. """ data = load_earth_age(resolution="01d", region=[-10, 10, -5, 5]) assert data.shape == (11, 21) diff --git a/pygmt/tests/test_datasets_earth_deflection.py b/pygmt/tests/test_datasets_earth_deflection.py index 449e35cfec3..afb666ac605 100644 --- a/pygmt/tests/test_datasets_earth_deflection.py +++ b/pygmt/tests/test_datasets_earth_deflection.py @@ -11,7 +11,7 @@ def test_earth_edefl_01d(): """ - Test some properties of the Earth east-west deflection 01d data. + Test some properties of Earth's east-west deflection 01d data. """ data = load_earth_deflection(resolution="01d") assert data.name == "z" @@ -58,7 +58,7 @@ def test_earth_edefl_01m_default_registration(): def test_earth_ndefl_01d(): """ - Test some properties of the Earth north-south deflection 01d data. + Test some properties of Earth's north-south deflection 01d data. """ data = load_earth_deflection(resolution="01d", component="north") assert data.name == "z" @@ -76,7 +76,7 @@ def test_earth_ndefl_01d(): def test_earth_ndefl_01d_with_region(): """ - Test loading low-resolution Earth north-south deflection with "region". + Test loading low-resolution Earth's north-south deflection with "region". """ data = load_earth_deflection( resolution="01d", region=[-10, 10, -5, 5], component="north" diff --git a/pygmt/tests/test_datasets_earth_dist.py b/pygmt/tests/test_datasets_earth_dist.py index 63f95751f45..e507f10a1e4 100644 --- a/pygmt/tests/test_datasets_earth_dist.py +++ b/pygmt/tests/test_datasets_earth_dist.py @@ -1,5 +1,5 @@ """ -Test basic functionality for loading Earth distance to shoreline datasets. +Test basic functionality for loading Earth's distance to shoreline datasets. """ import numpy as np @@ -10,7 +10,7 @@ def test_earth_dist_01d(): """ - Test some properties of the Earth distance to shoreline 01d data. + Test some properties of Earth's distance to shoreline 01d data. """ data = load_earth_dist(resolution="01d") assert data.name == "z" @@ -27,7 +27,7 @@ def test_earth_dist_01d(): def test_earth_dist_01d_with_region(): """ - Test loading low-resolution Earth distance to shoreline with "region". + Test loading low-resolution Earth's distance to shoreline with "region". """ data = load_earth_dist(resolution="01d", region=[-10, 10, -5, 5]) assert data.shape == (11, 21) diff --git a/pygmt/tests/test_datasets_earth_free_air_anomaly.py b/pygmt/tests/test_datasets_earth_free_air_anomaly.py index a2c07264e83..8130031cdbc 100644 --- a/pygmt/tests/test_datasets_earth_free_air_anomaly.py +++ b/pygmt/tests/test_datasets_earth_free_air_anomaly.py @@ -1,5 +1,5 @@ """ -Test basic functionality for loading Earth free air anomaly datasets. +Test basic functionality for loading Earth's free air anomaly datasets. """ import numpy as np @@ -10,7 +10,7 @@ def test_earth_faa_01d(): """ - Test some properties of the free air anomaly 01d data. + Test some properties of Earth's free air anomaly 01d data. """ data = load_earth_free_air_anomaly(resolution="01d") assert data.name == "z" @@ -28,7 +28,7 @@ def test_earth_faa_01d(): def test_earth_faa_01d_with_region(): """ - Test loading low-resolution earth free air anomaly with 'region'. + Test loading low-resolution Earth's free air anomaly with 'region'. """ data = load_earth_free_air_anomaly(resolution="01d", region=[-10, 10, -5, 5]) assert data.shape == (11, 21) @@ -57,7 +57,7 @@ def test_earth_faa_01m_default_registration(): def test_earth_faaerror_01d(): """ - Test some properties of the free air anomaly error 01d data. + Test some properties of Earth's free air anomaly error 01d data. """ data = load_earth_free_air_anomaly(resolution="01d", uncertainty=True) assert data.name == "z" @@ -75,7 +75,7 @@ def test_earth_faaerror_01d(): def test_earth_faaerror_01d_with_region(): """ - Test loading low-resolution earth free air anomaly error with 'region'. + Test loading low-resolution Earth's free air anomaly error with 'region'. """ data = load_earth_free_air_anomaly( resolution="01d", region=[-10, 10, -5, 5], uncertainty=True diff --git a/pygmt/tests/test_datasets_earth_geoid.py b/pygmt/tests/test_datasets_earth_geoid.py index 9919164a573..e28830bc7a6 100644 --- a/pygmt/tests/test_datasets_earth_geoid.py +++ b/pygmt/tests/test_datasets_earth_geoid.py @@ -1,5 +1,5 @@ """ -Test basic functionality for loading Earth geoid datasets. +Test basic functionality for loading Earth's geoid datasets. """ import numpy as np @@ -10,7 +10,7 @@ def test_earth_geoid_01d(): """ - Test some properties of the earth geoid 01d data. + Test some properties of Earth's geoid 01d data. """ data = load_earth_geoid(resolution="01d") assert data.name == "z" @@ -28,7 +28,7 @@ def test_earth_geoid_01d(): def test_earth_geoid_01d_with_region(): """ - Test loading low-resolution earth geoid with 'region'. + Test loading low-resolution Earth's geoid with "region". """ data = load_earth_geoid(resolution="01d", region=[-10, 10, -5, 5]) assert data.shape == (11, 21) diff --git a/pygmt/tests/test_datasets_earth_magnetic_anomaly.py b/pygmt/tests/test_datasets_earth_magnetic_anomaly.py index 8a606c3552b..4fecbd3f224 100644 --- a/pygmt/tests/test_datasets_earth_magnetic_anomaly.py +++ b/pygmt/tests/test_datasets_earth_magnetic_anomaly.py @@ -1,5 +1,5 @@ """ -Test basic functionality for loading Earth magnetic anomaly datasets. +Test basic functionality for loading Earth's magnetic anomaly datasets. """ import numpy as np @@ -12,7 +12,7 @@ def test_earth_mag_01d(): """ - Test some properties of the magnetic anomaly 01d data. + Test some properties of Earth's magnetic anomaly 01d data. """ data = load_earth_magnetic_anomaly(resolution="01d") assert data.name == "z" @@ -30,7 +30,7 @@ def test_earth_mag_01d(): def test_earth_mag_01d_with_region(): """ - Test loading low-resolution earth magnetic anomaly with 'region'. + Test loading low-resolution Earth's magnetic anomaly with "region". """ data = load_earth_magnetic_anomaly(resolution="01d", region=[-10, 10, -5, 5]) assert data.shape == (11, 21) @@ -59,7 +59,7 @@ def test_earth_mag_02m_default_registration(): def test_earth_mag4km_01d(): """ - Test some properties of the magnetic anomaly 4km 01d data. + Test some properties of Earth's magnetic anomaly 4km 01d data. """ data = load_earth_magnetic_anomaly(resolution="01d", data_source="emag2_4km") assert data.name == "z" @@ -77,7 +77,7 @@ def test_earth_mag4km_01d(): def test_earth_mag4km_01d_with_region(): """ - Test loading low-resolution earth magnetic anomaly 4km 01d with 'region'. + Test loading low-resolution Earth's magnetic anomaly 4km 01d with "region". """ data = load_earth_magnetic_anomaly( resolution="01d", @@ -133,7 +133,7 @@ def test_earth_mag_01d_wdmam(): def test_earth_mag_01d_wdmam_with_region(): """ - Test loading low-resolution WDMAM grid with 'region'. + Test loading low-resolution WDMAM grid with "region". """ data = load_earth_magnetic_anomaly( resolution="01d", @@ -167,7 +167,7 @@ def test_earth_mag_03m_wdmam_with_region(): def test_earth_mag_data_source_error(): """ - Test that an error is raised when an invalid argument is passed to 'data_source'. + Test that an error is raised when an invalid argument is passed to "data_source". """ with pytest.raises(GMTValueError): load_earth_magnetic_anomaly(resolution="01d", data_source="invalid") diff --git a/pygmt/tests/test_datasets_earth_mask.py b/pygmt/tests/test_datasets_earth_mask.py index fec4d124269..6cb9f7765c8 100644 --- a/pygmt/tests/test_datasets_earth_mask.py +++ b/pygmt/tests/test_datasets_earth_mask.py @@ -1,5 +1,5 @@ """ -Test basic functionality for loading Earth mask datasets. +Test basic functionality for loading Earth's mask datasets. """ import numpy as np @@ -10,7 +10,7 @@ def test_earth_mask_01d(): """ - Test some properties of the Earth mask 01d data. + Test some properties of Earth's mask 01d data. """ data = load_earth_mask(resolution="01d") assert data.name == "z" @@ -29,7 +29,7 @@ def test_earth_mask_01d(): def test_earth_mask_01d_with_region(): """ - Test loading low-resolution Earth mask with 'region'. + Test loading low-resolution Earth's mask with 'region'. """ data = load_earth_mask(resolution="01d", region=[-7, 4, 13, 19]) assert data.shape == (7, 12) diff --git a/pygmt/tests/test_datasets_earth_mean_sea_surface.py b/pygmt/tests/test_datasets_earth_mean_sea_surface.py index 0f4679b08cd..0201e962fc1 100644 --- a/pygmt/tests/test_datasets_earth_mean_sea_surface.py +++ b/pygmt/tests/test_datasets_earth_mean_sea_surface.py @@ -1,5 +1,5 @@ """ -Test basic functionality for loading Earth mean sea surface datasets. +Test basic functionality for loading Earth's mean sea surface datasets. """ import numpy as np @@ -10,7 +10,7 @@ def test_earth_mss_01d(): """ - Test some properties of the Earth mean sea surface 01d data. + Test some properties of Earth's mean sea surface 01d data. """ data = load_earth_mean_sea_surface(resolution="01d") assert data.name == "z" @@ -27,7 +27,7 @@ def test_earth_mss_01d(): def test_earth_mss_01d_with_region(): """ - Test loading low-resolution Earth mean sea surface with "region". + Test loading low-resolution Earth's mean sea surface with "region". """ data = load_earth_mean_sea_surface(resolution="01d", region=[-10, 10, -5, 5]) assert data.shape == (11, 21) diff --git a/pygmt/tests/test_datasets_earth_night.py b/pygmt/tests/test_datasets_earth_night.py index 91f8fb865ad..4a030cf423c 100644 --- a/pygmt/tests/test_datasets_earth_night.py +++ b/pygmt/tests/test_datasets_earth_night.py @@ -29,7 +29,7 @@ def test_black_marble_01d(): def test_black_marble_01d_with_region(): """ - Test loading low-resolution Black Marble with 'region'. + Test loading low-resolution Black Marble with "region". """ data = load_black_marble(resolution="01d", region=[-10, 10, -5, 5]) assert data.shape == (3, 10, 20) diff --git a/pygmt/tests/test_datasets_earth_relief.py b/pygmt/tests/test_datasets_earth_relief.py index ecb9ec42c84..62ad824e439 100644 --- a/pygmt/tests/test_datasets_earth_relief.py +++ b/pygmt/tests/test_datasets_earth_relief.py @@ -1,5 +1,5 @@ """ -Test basic functionality for loading Earth relief datasets. +Test basic functionality for loading Earth's relief datasets. """ import numpy as np @@ -16,7 +16,7 @@ @pytest.mark.parametrize("data_source", ["igpp", "synbath"]) def test_earth_relief_01d_igpp_synbath(data_source): """ - Test some properties of the earth relief 01d data with IGPP and SYNBATH data. + Test some properties of Earth's relief 01d data with IGPP and SYNBATH data. """ data = load_earth_relief(resolution="01d", data_source=data_source) assert data.name == "z" @@ -36,7 +36,7 @@ def test_earth_relief_01d_igpp_synbath(data_source): @pytest.mark.parametrize("data_source", ["gebco", "gebcosi"]) def test_earth_relief_01d_gebco(data_source): """ - Test some properties of the earth relief 01d data with GEBCO and GEBOCSI data. + Test some properties of Earth's relief 01d data with GEBCO and GEBOCSI data. """ data = load_earth_relief(resolution="01d", data_source=data_source) assert data.name == "z" @@ -55,7 +55,7 @@ def test_earth_relief_01d_gebco(data_source): def test_earth_relief_01d_with_region_srtm(): """ - Test loading low-resolution earth relief with 'region' with IGPP data. + Test loading low-resolution Earth's relief with 'region' with IGPP data. """ data = load_earth_relief( resolution="01d", @@ -72,7 +72,7 @@ def test_earth_relief_01d_with_region_srtm(): def test_earth_relief_01d_with_region_gebco(): """ - Test loading low-resolution earth relief with 'region' with GEBCO data. + Test loading low-resolution Earth's relief with 'region' with GEBCO data. """ data = load_earth_relief( resolution="01d", @@ -89,7 +89,7 @@ def test_earth_relief_01d_with_region_gebco(): def test_earth_relief_30m(): """ - Test some properties of the earth relief 30m data. + Test some properties of Earth's relief 30m data. """ data = load_earth_relief(resolution="30m") assert data.shape == (361, 721) @@ -120,7 +120,7 @@ def test_earth_gebcosi_15m_with_region(): def test_earth_relief_30s_synbath(): """ - Test some properties of the earth relief 30s data with SYNBATH data. + Test some properties of Earth's relief 30s data with SYNBATH data. """ data = load_earth_relief( region=[-95, -94, -1.5, -1], @@ -154,7 +154,7 @@ def test_earth_relief_03s_landonly_srtm(): def test_earth_relief_invalid_data_source(): """ - Test loading earth relief with invalid data_source argument. + Test loading Earth's relief with invalid data_source argument. """ with pytest.raises(GMTValueError): load_earth_relief( @@ -164,7 +164,7 @@ def test_earth_relief_invalid_data_source(): def test_earth_relief_invalid_data_source_with_use_srtm(): """ - Test loading earth relief with use_srtm=True and an incompatible data_source + Test loading Earth's relief with use_srtm=True and an incompatible data_source argument. """ with pytest.raises(GMTValueError): @@ -179,7 +179,7 @@ def test_earth_relief_invalid_data_source_with_use_srtm(): def test_earth_relief_03s_but_not_igpp(): """ - Test loading earth relief with resolution "03s" but data_source not "igpp". + Test loading Earth's relief with resolution "03s" but data_source not "igpp". """ for data_source in ["gebco", "gebcosi", "synbath"]: with pytest.raises(GMTValueError): diff --git a/pygmt/tests/test_datasets_earth_vertical_gravity_gradient.py b/pygmt/tests/test_datasets_earth_vertical_gravity_gradient.py index 1927560e91e..a2696b3ce5a 100644 --- a/pygmt/tests/test_datasets_earth_vertical_gravity_gradient.py +++ b/pygmt/tests/test_datasets_earth_vertical_gravity_gradient.py @@ -1,5 +1,5 @@ """ -Test basic functionality for loading Earth vertical gravity gradient datasets. +Test basic functionality for loading Earth's vertical gravity gradient datasets. """ import numpy as np @@ -10,7 +10,7 @@ def test_earth_vertical_gravity_gradient_01d(): """ - Test some properties of the earth vgg 01d data. + Test some properties of Earth's vgg 01d data. """ data = load_earth_vertical_gravity_gradient(resolution="01d") assert data.name == "z" @@ -29,7 +29,7 @@ def test_earth_vertical_gravity_gradient_01d(): def test_earth_vertical_gravity_gradient_01d_with_region(): """ - Test loading low-resolution earth vgg with 'region'. + Test loading low-resolution Earth's vgg with "region". """ data = load_earth_vertical_gravity_gradient( resolution="01d", region=[-10, 10, -5, 5] diff --git a/pygmt/tests/test_datasets_load_remote_datasets.py b/pygmt/tests/test_datasets_load_remote_datasets.py index dfa7fc5bf75..b9f1e549d58 100644 --- a/pygmt/tests/test_datasets_load_remote_datasets.py +++ b/pygmt/tests/test_datasets_load_remote_datasets.py @@ -10,7 +10,7 @@ def load_remote_dataset_wrapper(resolution="01d", region=None, registration=None): """ - Wrapper for _load_remote_dataset using the earth age dataset as an example. + Wrapper for _load_remote_dataset using Earth's age dataset as an example. """ return _load_remote_dataset( name="earth_age", @@ -24,7 +24,7 @@ def load_remote_dataset_wrapper(resolution="01d", region=None, registration=None @pytest.mark.benchmark def test_load_remote_dataset_benchmark_with_region(): """ - Benchmark loading a remote dataset with 'region'. + Benchmark loading a remote dataset with "region". """ data = load_remote_dataset_wrapper(resolution="01d", region=[-10, 10, -5, 5]) assert data.name == "z" diff --git a/pygmt/tests/test_datasets_mars_relief.py b/pygmt/tests/test_datasets_mars_relief.py index 2f3b81e942a..9ed1bfbc708 100644 --- a/pygmt/tests/test_datasets_mars_relief.py +++ b/pygmt/tests/test_datasets_mars_relief.py @@ -1,5 +1,5 @@ """ -Test basic functionality for loading Mars relief datasets. +Test basic functionality for loading Mars' relief datasets. """ import numpy as np @@ -10,7 +10,7 @@ def test_mars_relief_01d(): """ - Test some properties of the Mars relief 01d data. + Test some properties of Mars' relief 01d data. """ data = load_mars_relief(resolution="01d") assert data.name == "z" @@ -27,7 +27,7 @@ def test_mars_relief_01d(): def test_mars_relief_01d_with_region(): """ - Test loading low-resolution Mars relief with 'region'. + Test loading low-resolution Mars' relief with 'region'. """ data = load_mars_relief(resolution="01d", region=[-10, 10, -5, 5]) assert data.shape == (11, 21) diff --git a/pygmt/tests/test_datasets_mean_dynamic_topography.py b/pygmt/tests/test_datasets_mean_dynamic_topography.py index f14f2b6d4f1..b9c8c04cca5 100644 --- a/pygmt/tests/test_datasets_mean_dynamic_topography.py +++ b/pygmt/tests/test_datasets_mean_dynamic_topography.py @@ -1,5 +1,5 @@ """ -Test basic functionality for loading Earth mean dynamic topography datasets. +Test basic functionality for loading Earth's mean dynamic topography datasets. """ import numpy as np @@ -10,7 +10,7 @@ def test_earth_mdt_01d(): """ - Test some properties of the Earth mean dynamic topography 01d data. + Test some properties of Earth's mean dynamic topography 01d data. """ data = load_earth_mean_dynamic_topography(resolution="01d") assert data.name == "z" @@ -27,7 +27,7 @@ def test_earth_mdt_01d(): def test_earth_mdt_01d_with_region(): """ - Test loading low-resolution Earth mean dynamic topography with "region". + Test loading low-resolution Earth's mean dynamic topography with "region". """ data = load_earth_mean_dynamic_topography(resolution="01d", region=[-10, 10, -5, 5]) assert data.shape == (11, 21) diff --git a/pygmt/tests/test_datasets_mercury_relief.py b/pygmt/tests/test_datasets_mercury_relief.py index b9ba52c9379..eb1c7c51973 100644 --- a/pygmt/tests/test_datasets_mercury_relief.py +++ b/pygmt/tests/test_datasets_mercury_relief.py @@ -1,5 +1,5 @@ """ -Test basic functionality for loading Mercury relief datasets. +Test basic functionality for loading Mercury's relief datasets. """ import numpy as np @@ -10,7 +10,7 @@ def test_mercury_relief_01d(): """ - Test some properties of the Mercury relief 01d data. + Test some properties of Mercury's relief 01d data. """ data = load_mercury_relief(resolution="01d") assert data.name == "z" @@ -27,7 +27,7 @@ def test_mercury_relief_01d(): def test_mercury_relief_01d_with_region(): """ - Test loading low-resolution Mercury relief with 'region'. + Test loading low-resolution Mercury's relief with 'region'. """ data = load_mercury_relief(resolution="01d", region=[-10, 10, -5, 5]) assert data.shape == (11, 21) diff --git a/pygmt/tests/test_datasets_moon_relief.py b/pygmt/tests/test_datasets_moon_relief.py index 477ff4e0e8f..39dc406f9fe 100644 --- a/pygmt/tests/test_datasets_moon_relief.py +++ b/pygmt/tests/test_datasets_moon_relief.py @@ -1,5 +1,5 @@ """ -Test basic functionality for loading Moon relief datasets. +Test basic functionality for loading Moon's relief datasets. """ import numpy as np @@ -10,7 +10,7 @@ def test_moon_relief_01d(): """ - Test some properties of the Moon relief 01d data. + Test some properties of Moon's relief 01d data. """ data = load_moon_relief(resolution="01d") assert data.name == "z" @@ -27,7 +27,7 @@ def test_moon_relief_01d(): def test_moon_relief_01d_with_region(): """ - Test loading low-resolution Moon relief with 'region'. + Test loading low-resolution Moon's relief with 'region'. """ data = load_moon_relief(resolution="01d", region=[-10, 10, -5, 5]) assert data.shape == (11, 21) diff --git a/pygmt/tests/test_datasets_pluto_relief.py b/pygmt/tests/test_datasets_pluto_relief.py index d024c7314de..d51a0b20dd1 100644 --- a/pygmt/tests/test_datasets_pluto_relief.py +++ b/pygmt/tests/test_datasets_pluto_relief.py @@ -1,5 +1,5 @@ """ -Test basic functionality for loading Pluto relief datasets. +Test basic functionality for loading Pluto's relief datasets. """ import numpy as np @@ -10,7 +10,7 @@ def test_pluto_relief_01d(): """ - Test some properties of the Pluto relief 01d data. + Test some properties of Pluto's relief 01d data. """ data = load_pluto_relief(resolution="01d") assert data.name == "z" @@ -27,7 +27,7 @@ def test_pluto_relief_01d(): def test_pluto_relief_01d_with_region(): """ - Test loading low-resolution Pluto relief with 'region'. + Test loading low-resolution Pluto's relief with 'region'. """ data = load_pluto_relief(resolution="01d", region=[-10, 10, -5, 5]) assert data.shape == (11, 21) diff --git a/pygmt/tests/test_datasets_venus_relief.py b/pygmt/tests/test_datasets_venus_relief.py index 6cbe5123bb7..24a27ba7ebf 100644 --- a/pygmt/tests/test_datasets_venus_relief.py +++ b/pygmt/tests/test_datasets_venus_relief.py @@ -1,5 +1,5 @@ """ -Test basic functionality for loading Venus relief datasets. +Test basic functionality for loading Venus' relief datasets. """ import numpy as np @@ -10,7 +10,7 @@ def test_venus_relief_01d(): """ - Test some properties of the Venus relief 01d data. + Test some properties of Venus' relief 01d data. """ data = load_venus_relief(resolution="01d") assert data.name == "z" @@ -27,7 +27,7 @@ def test_venus_relief_01d(): def test_venus_relief_01d_with_region(): """ - Test loading low-resolution Venus relief with 'region'. + Test loading low-resolution Venus' relief with 'region'. """ data = load_venus_relief(resolution="01d", region=[-10, 10, -5, 5]) assert data.shape == (11, 21) diff --git a/pygmt/tests/test_grdfilter.py b/pygmt/tests/test_grdfilter.py index b318da9ba8e..625d893ce89 100644 --- a/pygmt/tests/test_grdfilter.py +++ b/pygmt/tests/test_grdfilter.py @@ -17,7 +17,7 @@ @pytest.fixture(scope="module", name="grid") def fixture_grid(): """ - Load the grid data from the static earth relief file. + Load the grid data from the static Earth's relief file. """ return load_static_earth_relief() diff --git a/pygmt/tests/test_xarray_accessor.py b/pygmt/tests/test_xarray_accessor.py index 559e8531bb9..9794d2e543e 100644 --- a/pygmt/tests/test_xarray_accessor.py +++ b/pygmt/tests/test_xarray_accessor.py @@ -141,7 +141,7 @@ def test_xarray_accessor_tiled_grid_slice_and_add(): Unit test to track https://github.com/GenericMappingTools/pygmt/issues/524 """ - # Load the 05m earth relief grid, which is stored as tiles. + # Load the 05m Earth's relief grid, which is stored as tiles. grid = load_earth_relief( resolution="05m", region=[0, 5, -5, 5], registration="pixel" )