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_001.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]

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

[weiji14]

Some suggestions to add an inline example, and allow configuring the width/height. Still need to finalize the docstring (copy over from fig.image?).

[weiji14]

Add an inline example

Suggested change

	"""
	Examples
	--------
	>>> import pygmt
	>>> fig = pygmt.Figure()
	>>> fig.basemap(region=[-90, -70, 0, 20], projection="M10c", frame=True)
	>>> fig.pygmtlogo(
	... shape="circle",
	... theme="light",
	... wordmark="horizontal",
	... color=True,
	... position="BR",
	... height="1c",
	... )
	>>> fig.show()
	"""

[weiji14]

Add __doctest_skip__ for inline example, and make _create_logo private function.

Suggested change

	def create_logo( # noqa: PLR0915
	__doctest_skip__ = ["pygmtlogo"]
	def _create_logo( # noqa: PLR0915

[weiji14]

Suggested change

	fig_name_logo = create_logo(
	fig_name_logo = _create_logo(

[weiji14]

Allow configuring width/height also

Suggested change

	position=None, # -> Use position parameter of Figure.image
	position=None, # -> Use position parameter of Figure.image
	width=None, # -> Use width parameter of Figure.image
	height=None, # -> Use height parameter of Figure.image

[weiji14]

Suggested change

	position=position,
	position=position,
	width=width,
	height=height,