Skip to content

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

Open
yvonnefroehlich wants to merge 14 commits into
mainfrom
add-desgin-idea-docstring
Open

WIP: DOC: Add design idea of PyGMT logo to docstrings#4719
yvonnefroehlich wants to merge 14 commits into
mainfrom
add-desgin-idea-docstring

Conversation

@yvonnefroehlich

@yvonnefroehlich yvonnefroehlich commented Jul 6, 2026

Copy link
Copy Markdown
Member

Description of proposed changes

xref: #4715 (comment), #4715 (comment)

based on: #1404 (comment)

Preview:

Guidelines

Slash Commands

You can write slash commands (/command) in the first line of a comment to perform
specific operations. Supported slash command is:

  • /format: automatically format and lint the code

@yvonnefroehlich yvonnefroehlich added this to the 0.19.0 milestone Jul 6, 2026
@yvonnefroehlich yvonnefroehlich self-assigned this Jul 6, 2026
@yvonnefroehlich yvonnefroehlich added documentation Improvements or additions to documentation skip-changelog Skip adding Pull Request to changelog labels Jul 6, 2026
Co-authored-by: Michael Grund <23025878+michaelgrund@users.noreply.github.com>
@yvonnefroehlich yvonnefroehlich marked this pull request as draft July 6, 2026 12:11
Comment thread pygmt/src/pygmtlogo.py Outdated
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".

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.

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.

@yvonnefroehlich yvonnefroehlich marked this pull request as ready for review July 6, 2026 20:46
Comment thread pygmt/src/logo.py Outdated
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation skip-changelog Skip adding Pull Request to changelog

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants