Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions doc/changes.md
Original file line number Diff line number Diff line change
Expand Up @@ -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))
Expand Down Expand Up @@ -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**:
Expand Down Expand Up @@ -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))
Expand Down
2 changes: 1 addition & 1 deletion examples/gallery/images/track_sampling.py
Original file line number Diff line number Diff line change
Expand Up @@ -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")
Expand Down
2 changes: 1 addition & 1 deletion examples/tutorials/advanced/3d_perspective_image.py
Original file line number Diff line number Diff line change
Expand Up @@ -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])

# %%
Expand Down
2 changes: 1 addition & 1 deletion examples/tutorials/advanced/contour_map.py
Original file line number Diff line number Diff line change
Expand Up @@ -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])


Expand Down
14 changes: 7 additions & 7 deletions examples/tutorials/advanced/working_with_panel.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
"""

# %%
Expand All @@ -36,7 +36,7 @@
#
# The `Orthographic projection
# <https://www.pygmt.org/dev/projections/azim/azim_orthographic.html>`__
# 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.
Expand All @@ -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).
Expand Down Expand Up @@ -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
Expand Down
8 changes: 4 additions & 4 deletions pygmt/datasets/earth_age.py
Original file line number Diff line number Diff line change
@@ -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.
Expand All @@ -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
Expand Down Expand Up @@ -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
Expand Down
8 changes: 4 additions & 4 deletions pygmt/datasets/earth_dist.py
Original file line number Diff line number Diff line change
@@ -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.
Expand All @@ -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
Expand Down Expand Up @@ -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).

Expand Down
12 changes: 6 additions & 6 deletions pygmt/datasets/earth_free_air_anomaly.py
Original file line number Diff line number Diff line change
@@ -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.
Expand All @@ -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

Expand Down Expand Up @@ -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
Expand Down
10 changes: 5 additions & 5 deletions pygmt/datasets/earth_geoid.py
Original file line number Diff line number Diff line change
@@ -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.
"""
Expand All @@ -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
Expand Down Expand Up @@ -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
Expand Down
6 changes: 3 additions & 3 deletions pygmt/datasets/earth_magnetic_anomaly.py
Original file line number Diff line number Diff line change
@@ -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.
Expand All @@ -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
Expand Down Expand Up @@ -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
Expand Down
10 changes: 5 additions & 5 deletions pygmt/datasets/earth_mask.py
Original file line number Diff line number Diff line change
@@ -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.
"""
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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:

Expand Down
8 changes: 4 additions & 4 deletions pygmt/datasets/earth_mean_dynamic_topography.py
Original file line number Diff line number Diff line change
@@ -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.
Expand All @@ -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
Expand Down Expand Up @@ -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
Expand Down
8 changes: 4 additions & 4 deletions pygmt/datasets/earth_mean_sea_surface.py
Original file line number Diff line number Diff line change
@@ -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.
Expand All @@ -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
Expand Down Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion pygmt/datasets/earth_night.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Loading