Figure.pygmtlogo: Initial version for the circular, colored PyGMT logo

[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
• DOC: 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]

I think the circular, colored version of the PyGMT logo is good enough to be finalized. I've changed the base branch to pygmtlogo and updated the PR title.

OK to merge after addressing comment #3849 (comment).

[seisman]

/format