POC: Code PyGMT logo in PyGMT

[yvonnefroehlich]

Description of proposed changes

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

• Python script
• 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)
• Gallery example

Preview:

• Documentation: https://pygmt-dev--3849.org.readthedocs.build/en/3849/api/generated/pygmt.Figure.pygmtlogo.html
• Gallery example: https://pygmt-dev--3849.org.readthedocs.build/en/3849/gallery/embellishments/pygmt_logo.html
• Script by @seisman to generate all versions See POC: Code PyGMT logo in PyGMT #3849 (comment); modified version to use the changed parameter names at POC: Code PyGMT logo in PyGMT #3849 (comment)
• All combinations: https://pygmt-dev--3849.org.readthedocs.build/en/3849/_images/sphx_glr_pygmt_logo_100.png

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

TODO:

• Update intro comment of this PR
• Remove temporary files (eps)
• Include adding a wordmark and it's orientation to the input at the beginning
• Update codes to finale version of the visual
  • space between horizontal line of letter G and letter M (POC: Code PyGMT logo in PyGMT #3849 (comment))
  • ending of yellow line at the right side of letter M (POC: Code PyGMT logo in PyGMT #3849 (comment))
  • clean boundary of shape (0aea0b0)
  • etc.
• Introduce variables
• Improve parameter names, e.g., shape="circle" | "hexagon" or hex=False | True
• Convert to function (remove show and rdeuce save to tempoary eps files, replot via Figure.image)
• Remove saving as eps file for rotation (first get ride of transparent margin)
• Remove saving as eps file for adding wordmark (different basemaps due to horizontal and vertical orientation)
• Convert to a method of the Figure class or addition to Figure.logo.
• Add or expand gallery example to use the method
• Explain the story behind the logo in the gallery example

Issues:

• Get ride of white or transparent margin
• Currently the rotation and adding the wordmark are done in new Figure objects using the saved eps files. Maybe this is not easy to handle when converting to a method of the Figure classe.
• Decide about font for the wordmark (font Space Grotesk by Florian Karsten not available in GMT)
• No direct export to SVG format possible
• etc.

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]

Time to work on the PyGMT logo and refresh my memory about it.

I'm wondering if it helps to define a few private helper functions inside the create_logo function, e.g., _letter_g_coords (lines 150-161), _letter_m_coords (lines 175-210), and _letter_t_coords (lines 216-220), which returns x/y coordinates of letters G/M/T, respectively. It would shorten the create_logo function, but may make it easier to read.