GMT-Ghostscript incompatibility: Give recommendations and extend examples #3249

yvonnefroehlich · 2024-05-14T15:03:28Z

Description of proposed changes

The incompatibility of some GMT Ghostscript version combinations causes not working transparency.

This PR adds

a transprency element to the "Getting started" example
Preview: https://github.com/GenericMappingTools/pygmt/tree/mention-gs-gmt-transprency?tab=readme-ov-file#getting-started
a transprency element to the "Testing your installation" example
Preview: https://pygmt-dev--3249.org.readthedocs.build/en/3249/install.html#testing-your-install
a note to the "Commen installation issues" list
Preview: https://pygmt-dev--3249.org.readthedocs.build/en/3249/install.html#common-installation-issues
a reminder to the "release checklist" issue template
Preview: https://github.com/GenericMappingTools/pygmt/blob/mention-gs-gmt-transprency/.github/ISSUE_TEMPLATE/4-release_checklist.md

Related to

Fixes: #3242 (comment)

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.
Use underscores (not hyphens) in names of Python files and directories.

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

README.md

doc/install.md

seisman · 2024-05-14T23:57:27Z

doc/install.md

-fig.coast(region="g", frame=True, shorelines=1)
+fig.coast(projection="N10c", region="g", frame=True, land="tan", water="lightblue")
+# Add a semi-transparent text element
+fig.text(position="MC", text="PyGMT", font="60p,Helvetica-Bold,red@75")
 fig.show()
 ```


It would be great if we can add the image here so that it's more straightforward to see the differences if any. But I'm unsure what's the best way to add the image here.

Yes, this would definitely be nice! I was also thinking about this while writing the explanation comment. I have to see when I have time to figure out a solution - maybe a table: left the code and right the image?