Skip to content

Remote datasets: Include images of the official documentation in API reference #2728

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
seisman merged 23 commits into from
Oct 12, 2023
Merged

Remote datasets: Include images of the official documentation in API reference #2728

Show file tree
Hide file tree
Changes from 16 commits
Commits
Show all changes
23 commits
Select commit Hold shift + click to select a range
5362c7a
Add links to image of remote datasets
yvonnefroehlich Oct 9, 2023
e5fa10f
Fix typo
yvonnefroehlich Oct 9, 2023
3acde0e
Test image vs figure
yvonnefroehlich Oct 9, 2023
ef531cd
Add missing indent
yvonnefroehlich Oct 9, 2023
a18c64e
Update remaining datasets image to figure
yvonnefroehlich Oct 9, 2023
bacff01
Add missing indent
yvonnefroehlich Oct 9, 2023
f039ff2
Update magnetic dataset image to figure
yvonnefroehlich Oct 9, 2023
414a319
Add missing white space
yvonnefroehlich Oct 9, 2023
fdfa599
Move images at the top
yvonnefroehlich Oct 9, 2023
6b0d9f8
Fix line length
yvonnefroehlich Oct 9, 2023
666960a
Reduce size of images for magnetic datasets
yvonnefroehlich Oct 9, 2023
a94ac4f
Test relative size 80% instead of fix size 700px
yvonnefroehlich Oct 9, 2023
8c0b986
Use relative size 80% instead of fix size 700px for the other datasets
yvonnefroehlich Oct 9, 2023
111b0c1
Add table with images of magnetic dataset
yvonnefroehlich Oct 9, 2023
9fb1f13
Shorten line length of table
yvonnefroehlich Oct 9, 2023
8399c28
Add missing blank line
yvonnefroehlich Oct 9, 2023
5b17e6b
Use list-table syntax
yvonnefroehlich Oct 10, 2023
b06dd01
Fix indent
yvonnefroehlich Oct 10, 2023
e3d5b5f
Merge branch 'main' into add-link-image-datasets
yvonnefroehlich Oct 10, 2023
e77a24f
Use # noqa: W505 to allow for longer lines
yvonnefroehlich Oct 10, 2023
3a0fa1c
Write links in one line with 'figure::'
yvonnefroehlich Oct 11, 2023
0cc6faf
Merge branch 'main' into add-link-image-datasets
yvonnefroehlich Oct 11, 2023
1fce1ef
Write links also for the other remote datasets in the line with 'figu…
yvonnefroehlich Oct 11, 2023
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
7 changes: 7 additions & 0 deletions pygmt/datasets/earth_age.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,13 @@ def load_earth_age(resolution="01d", region=None, registration=None):
r"""
Load the Earth seafloor crustal age dataset in various resolutions.

.. figure::
https://www.generic-mapping-tools.org/remote-datasets/_images/GMT_age.png # noqa: W505
:width: 80 %
:align: center

Earth seafloor crustal age dataset.

The grids are downloaded to a user data directory
(usually ``~/.gmt/server/earth/earth_age/``) the first time you invoke
this function. Afterwards, it will load the grid from the data directory.
Expand Down
7 changes: 7 additions & 0 deletions pygmt/datasets/earth_free_air_anomaly.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,13 @@ def load_earth_free_air_anomaly(resolution="01d", region=None, registration=None
Load the IGPP Global Earth Free-Air Anomaly datatset in various
resolutions.

.. figure::
https://www.generic-mapping-tools.org/remote-datasets/_images/GMT_faa.jpg # noqa: W505
:width: 80 %
:align: center

IGPP Global Earth Free-Air Anomaly datatset.

The grids are downloaded to a user data directory
(usually ``~/.gmt/server/earth/earth_faa/``) the first time you invoke
this function. Afterwards, it will load the grid from the data directory.
Expand Down
7 changes: 7 additions & 0 deletions pygmt/datasets/earth_geoid.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,13 @@ def load_earth_geoid(resolution="01d", region=None, registration=None):
r"""
Load the EGM2008 Global Earth Geoid dataset in various resolutions.

.. figure::
https://www.generic-mapping-tools.org/remote-datasets/_images/GMT_geoid.jpg # noqa: W505
:width: 80 %
:align: center

EGM2008 Global Earth Geoid dataset.

The grids are downloaded to a user data directory
(usually ``~/.gmt/server/earth/earth_geoid/``) the first time you invoke
this function. Afterwards, it will load the grid from the data directory.
Expand Down
11 changes: 11 additions & 0 deletions pygmt/datasets/earth_magnetic_anomaly.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,17 @@ def load_earth_magnetic_anomaly(
r"""
Load the Earth magnetic anomaly datasets in various resolutions.

+-----------------------------------+-----------------------------------+
| Global Earth Magnetic | World Digital Magnetic |
| Anomaly Model (EMAG2) | Anomaly Map (WDMAM) |
+===================================+===================================+
| .. figure:: | .. figure:: |
| https:// | https:// |
| www.generic-mapping-tools.org/ | www.generic-mapping-tools.org/ |
| remote-datasets/ | remote-datasets/ |
| _images/GMT_mag.jpg | _images/GMT_wdmam.jpg |
+-----------------------------------+-----------------------------------+

The grids are downloaded to a user data directory
(usually ``~/.gmt/server/earth/earth_mag/``,
``~/.gmt/server/earth/earth_mag4km/``,
Expand Down
7 changes: 7 additions & 0 deletions pygmt/datasets/earth_mask.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,13 @@ def load_earth_mask(resolution="01d", region=None, registration=None):
r"""
Load the GSHHG Global Earth Mask dataset in various resolutions.

.. figure::
https://www.generic-mapping-tools.org/remote-datasets/_images/GMT_earthmask.png # noqa: W505
:width: 80 %
:align: center

GSHHG Global Earth Mask dataset.

The grids are downloaded to a user data directory
(usually ``~/.gmt/server/earth/earth_mask/``) the first time you invoke
this function. Afterwards, it will load the grid from the data directory.
Expand Down
7 changes: 7 additions & 0 deletions pygmt/datasets/earth_relief.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,13 @@ def load_earth_relief(
Load the Earth relief datasets (topography and bathymetry) in various
resolutions.

.. figure::
https://www.generic-mapping-tools.org/remote-datasets/_images/GMT_gebcosi.jpg # noqa: W505
:width: 80 %
:align: center

Earth relief datasets (topography and bathymetry).

The grids are downloaded to a user data directory
(usually ``~/.gmt/server/earth/earth_relief``,
``~/.gmt/server/earth/earth_gebco``, ``~/.gmt/server/earth/earth_gebcosi``,
Expand Down
7 changes: 7 additions & 0 deletions pygmt/datasets/earth_vertical_gravity_gradient.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,13 @@ def load_earth_vertical_gravity_gradient(
Load the IGPP Global Earth Vertical Gravity Gradient dataset in various
resolutions.

.. figure::
https://www.generic-mapping-tools.org/remote-datasets/_images/GMT_vgg.jpg # noqa: W505
:width: 80 %
:align: center

IGPP Global Earth Vertical Gravity Gradient dataset.

The grids are downloaded to a user data directory
(usually ``~/.gmt/server/earth/earth_vgg/``) the first time you invoke
this function. Afterwards, it will load the grid from the data directory.
Expand Down