Skip to content

DOC: Add design idea of PyGMT logo to docstrings #4719

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 15 commits into from
Jul 7, 2026
Merged

DOC: Add design idea of PyGMT logo to docstrings #4719

Changes from 3 commits
Commits
Show all changes
15 commits
Select commit Hold shift + click to select a range
411af07
Add design idea of PyGMT logo to docstrings
yvonnefroehlich Jul 6, 2026
ab32563
Fix typos
yvonnefroehlich Jul 6, 2026
c274387
Merge branch 'main' into add-desgin-idea-docstring
yvonnefroehlich Jul 6, 2026
7510f77
Add image of PyGMT logo
yvonnefroehlich Jul 6, 2026
6dd16c2
Add more details
yvonnefroehlich Jul 6, 2026
451f281
Fix link to PyGMT logo image
yvonnefroehlich Jul 6, 2026
0dc9c2e
Improve formulation
yvonnefroehlich Jul 6, 2026
fd8472c
Fix line length
yvonnefroehlich Jul 6, 2026
330c601
Add references between the two logo docs
yvonnefroehlich Jul 6, 2026
cfe9c70
Fix link
yvonnefroehlich Jul 6, 2026
2fe2a54
Adjust with of PyGMT logo image
yvonnefroehlich Jul 6, 2026
20e59e5
Merge branch 'main' into add-desgin-idea-docstring
yvonnefroehlich Jul 7, 2026
d6eced6
Use 'See also' boxes
yvonnefroehlich Jul 7, 2026
2e67d5c
Fix typo
yvonnefroehlich Jul 7, 2026
18887e4
Revert "Fix typo"
yvonnefroehlich Jul 7, 2026
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
2 changes: 2 additions & 0 deletions pygmt/src/pygmtlogo.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -294,6 +294,8 @@ def pygmtlogo( # noqa: PLR0913
The design of the logo is kindly provided by `@sfrooti <https://github.com/sfrooti>`_
and consists of a visual and the wordmark "PyGMT".

The outer shape represents the Earth, with compass lines surrounding the letters "GMT".

@michaelgrund michaelgrund Jul 6, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
The outer shape represents the Earth, with compass lines surrounding the letters "GMT".
The outer shape represents Earth, with compass lines surrounding the letters "GMT".

Either Earth or the earth, see https://english.stackexchange.com/questions/326641/the-earth-vs-earth
I would prefer Earth.

@yvonnefroehlich yvonnefroehlich Jul 7, 2026

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Interesting discussion. Does this mean we need to updated the Earth relief to the earth relief or Earth relief and similar for the other datasets across the documentation?

Admin@A181941 /cygdrive/c/users/Admin/C2/008_github_repos/github_pygmt/pygmt
$ grep -r "the Earth" *
doc/overview.md:a command-line program widely used across the Earth, Ocean, and Planetary sciences and
examples/gallery/3d_plots/3d_bar.py:# Download a grid for the Earth relief with a resolution of 10 arc-minutes
examples/gallery/maps/tilemaps.py:    # Higher levels mean a zoom level closer to the Earth's
examples/intro/02_contour_map.py:This tutorial page covers the basics of creating a figure of the Earth relief, using a
examples/intro/02_contour_map.py:# Loading the Earth relief dataset
examples/intro/02_contour_map.py:# the Earth relief values to a specific color within the CPT. In this case, the CPT
examples/intro/02_contour_map.py:# To show how the plotted colors relate to the Earth relief, a colorbar can be added
examples/projections/azim/azim_general_perspective.py:The perspective projection imitates the view of the Earth from a finite
examples/projections/azim/azim_gnomonic.py:Earth. As a consequence great circles (orthodromes) on the surface of the Earth
examples/tutorials/advanced/draping_on_3d_surface.py:# of :meth:`pygmt.Figure.grdview`; here we use a grid of the Earth relief. To add a
examples/tutorials/advanced/working_with_panel.py:# can be used to show the Earth as a globe. Land and water masses are
examples/tutorials/advanced/working_with_panel.py:# To generate a rotation of the Earth around the vertical axis, the central
examples/tutorials/advanced/working_with_panel.py:# displayed. Here, the Earth relief is shown by color-coding the elevation.
pygmt/datasets/earth_age.py:Function to download the Earth seafloor crustal age dataset from the GMT data server,
pygmt/datasets/earth_age.py:    Load the Earth seafloor crustal age dataset in various resolutions.
pygmt/datasets/earth_free_air_anomaly.py:        By default, the Earth free-air anomaly values are returned. Set to ``True`` to
pygmt/datasets/earth_magnetic_anomaly.py:Function to download the Earth magnetic anomaly datasets from the GMT data server, and
pygmt/datasets/earth_magnetic_anomaly.py:    Load the Earth magnetic anomaly datasets in various resolutions.
pygmt/datasets/earth_relief.py:Function to download the Earth relief datasets from the GMT data server, and load as
pygmt/datasets/earth_relief.py:    Load the Earth relief datasets (topography and bathymetry) in various resolutions.
pygmt/datasets/earth_relief.py:        Select the source for the Earth relief data. Available options are:
pygmt/src/solar.py:    >>> # create a map of the Earth with the coast method
pygmt/tests/test_datasets_earth_deflection.py:    Test some properties of the Earth east-west deflection 01d data.
pygmt/tests/test_datasets_earth_deflection.py:    Test some properties of the Earth north-south deflection 01d data.
pygmt/tests/test_datasets_earth_dist.py:    Test some properties of the Earth distance to shoreline 01d data.
pygmt/tests/test_datasets_earth_mask.py:    Test some properties of the Earth mask 01d data.
pygmt/tests/test_datasets_earth_mean_sea_surface.py:    Test some properties of the Earth mean sea surface 01d data.
pygmt/tests/test_datasets_mean_dynamic_topography.py:    Test some properties of the Earth mean dynamic topography 01d data.
pygmt/__init__.py:Mapping Tools (GMT), a command-line program widely used across the Earth, Ocean, and
pygmt.egg-info/PKG-INFO:program widely used across the Earth, Ocean, and Planetary sciences and beyond.
README.md:program widely used across the Earth, Ocean, and Planetary sciences and beyond.


Parameters
----------
shape
Expand Down
Loading