WIP: 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
• 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.

[yvonnefroehlich]

The commit history is so long that it's really painful to find any old comments...

Oh, yes!! I already started making a list of still relevant review comments 😅.

[seisman]

The commit history is so long that it's really painful to find any old comments...

Oh, yes!! I already started making a list of still relevant review comments 😅.

I wonder if we should merge this PR into a separate branch (not main) and then open a separate PR. In this way, we would have much cleaner commit history.

[yvonnefroehlich]

I think the colored circular version is already very good now, and we should add a test and baseline image for it, so that any further changes don't break it suddently.

Agree, we should focus on the circular version for now. The hexagon version would be nice to have and hex stickers seem to be quite popular. But the hexagon shape makes things so much more (too) complicated and it is difficult to implement things based on calculation rather than on empircal factors. Furthuremore only the circular version directly has the relation to the Earth.

I wonder if we should merge this PR into a separate branch (not main) and then open a separate PR. In this way, we would have much cleaner commit history.

Joa, we can try this. Should test and baseline image added before?

[seisman]

Should test and baseline image added before?

I think yes

[yvonnefroehlich]

I removed the script for the gallery example. I think we should add it in a separate PR. And the current version was not really a gallery example, but a summary of all versions of the logo.

[yvonnefroehlich]

Maybe we can combine some of the tests into one test to have less baseline images.

[seisman]

Maybe we can combine some of the tests into one test to have less baseline images.

I think so. Maybe we can start with a test including the following two logos:

[seisman]

I wonder if we should merge this PR into a separate branch (not main) and then open a separate PR. In this way, we would have much cleaner commit history.

Joa, we can try this.

I've created the pygmtlogo branch. I think we can change the base branch of this PR to pygmtlogo, then merge this PR after you add the tests and baseline images.

[seisman]

I wonder if it makes more sense to have wordmark default to False.

[seisman]

If we ignore the factor size/256, currently, the thicknesses are:

thick_shape = r0 - r1 = 74
thick_gt = r4 - r5 = 28
thick_m = r4 / 5 = 21.2
thick_comp = 74/3=24.666666
thick_gap = 18.5

I wonder if we could slightly change the radii so that all the above values are integers.

[seisman]

It's not ideal to hardcode the eps file name in this function. Instead, the pygmtlogo function should use GMTTempoaryFile and pass a tempoary file name to this function.