Code PyGMT logo in PyGMT

[yvonnefroehlich]

Description of proposed changes

Related to #1404 (comment), create the PyGMT logo in Python with PyGMT:

• Python script
• Separate method Figure.pygmtlogo or Figure.logo_pygmt as part of the Figure class or
  addition to the method Figure.logo (which plots the GMT logo)
• Documentation
• Tests -> only circular, color, light and dark themes
• Gallery example -> separate PR

Related to

• Design a logo for PyGMT #1404
• Add a separate function to generate the PyGMT logo? #3848
• POC: Add PyGMT logo to README & docs #3845

Preview:
https://pygmt-dev--3849.org.readthedocs.build/en/3849/api/generated/pygmt.Figure.pygmtlogo.html

Reminders

• Run make format and make check to make sure the code follows the style guide.
• Add tests for new features or tests that would have caught the bug that you're fixing.
• Add new public functions/methods/classes to doc/api/index.rst.
• Write detailed docstrings for all functions/methods.
• If wrapping a new module, open a 'Wrap new GMT module' issue and submit reasonably-sized PRs.
• If adding new functionality, add an example to docstrings or tutorials.

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]

/format

[michaelgrund]

I feel the logo definition should be separated into a standalone method, similar to the method to plot the GMT logo. This would allow to plot the PyGMT logo by calling something like pygmt.Figure.pygmt_logo. The individual formats could be selected by different input parameters like you did or hex = True or darkmode = True.

[yvonnefroehlich]

ruff v0.10.0 was released 2 hours ago causing the newly falling code style checks.

[seisman]

• separat method Figure.pygmtlogo or Figure.logo_pygmt as part of the Figure class or addition to the method Figure.logo (which plots the GMT logo)

@yvonnefroehlich You can follow the steps below:

1. Create a pygmtlogo.py file under the pygmt/src/ directory
2. Move the current pygmtlogo function to this file
3. Add self as the first parameter of the pygmtlogo function
4. Change fig.image (line 269) to self.image.
5. Add from pygmt.src.pygmtlogo import pygmtlogo in pygmt/src/__init__.py
6. Near line 429 in pygmt/figure.py, add pygmtlogo.

Then, you should be able to call Figure.pygmtlogo to add the logo.

[seisman]

Perhaps we can add a baseline image for the test, then merge this PR into the pygmtlogo branch and start a new PR?

[yvonnefroehlich]

Perhaps we can add a baseline image for the test, then merge this PR into the pygmtlogo branch and start a new PR?

I triedy adding the baseline image, but again it looks like it was not successful.

[seisman]

Perhaps we can add a baseline image for the test, then merge this PR into the pygmtlogo branch and start a new PR?

I triedy adding the baseline image, but again it looks like it was not successful.

Could you please try to change the following lines

pygmt/.github/workflows/dvc-diff.yml

Lines 38 to 39 in 60aa837

	- name: Setup continuous machine learning (CML)
	uses: iterative/setup-cml@1b5ab8766e715e8f1aab96bbb1f4f2e3e1e8af45 # v3

to

- name: Setup continuous machine learning (CML) 
  uses: iterative/setup-cml@1b5ab8766e715e8f1aab96bbb1f4f2e3e1e8af45 # v3 
  with:
    vega: false     

and see if the workflow works.

[github-actions]

Summary of changed images

This is an auto-generated report of images that have changed on the DVC remote

Status	Path
added	pygmt/tests/baseline/test_pygmtlogo.png

Image diff(s)

Details

Added images

• test_pygmtlogo.png

Modified images

Path	Old	New

Report last updated at commit 4bc9f68

[yvonnefroehlich]

Perhaps we can add a baseline image for the test, then merge this PR into the pygmtlogo branch and start a new PR?

I triedy adding the baseline image, but again it looks like it was not successful.

Could you please try to change the following lines

pygmt/.github/workflows/dvc-diff.yml

Lines 38 to 39 in 60aa837

	- name: Setup continuous machine learning (CML)
	uses: iterative/setup-cml@1b5ab8766e715e8f1aab96bbb1f4f2e3e1e8af45 # v3

to

- name: Setup continuous machine learning (CML) 
  uses: iterative/setup-cml@1b5ab8766e715e8f1aab96bbb1f4f2e3e1e8af45 # v3 
  with:
    vega: false     

and see if the workflow works.

Seems like this helped. Thanks!

[yvonnefroehlich]

Perhaps we can add a baseline image for the test, then merge this PR into the pygmtlogo branch and start a new PR?

Sounds good!

BTW there is also the layered-animation branch which was used to create animations to show the plotting order of the single elements of the logo.

[yvonnefroehlich]

As this PR has a very long comment and commit history, and it's difficult to quickly find a specific comment or discussion, we plan to merge this PR first and start follow-up PRs to work on open aspects. Some aspects are already (partly) addressed, and the list is probably not complete:

• specific branchs for
  • creating the PyGMT logo: https://github.com/GenericMappingTools/pygmt/tree/pygmtlogo
  • animation of plotting / stacking order: https://github.com/GenericMappingTools/pygmt/tree/layered-animation
• hexagon shape: support or drop
  Code PyGMT logo in PyGMT #3849 (comment)
  • outer endings of main compass lines -> coverage by other shape
  • arrow length of letter T
  • same figure size across shapes
  • position of wordmark, distance to visual
• examples: no projection and region parameters
  • inline: Code PyGMT logo in PyGMT #3849 (comment)
  • gallery: separate PR
• wordmark: consistency with GMT
  • font type: Code PyGMT logo in PyGMT #3849 (comment)
  • URL: Code PyGMT logo in PyGMT #3849 (comment)
  • default: Code PyGMT logo in PyGMT #3849 (comment)
• radii: fractions
  • integer: Code PyGMT logo in PyGMT #3849 (comment)
  • 128: Code PyGMT logo in PyGMT #3849 (comment)
• docstrings: support width and height parameters
  • Code PyGMT logo in PyGMT #3849 (review)