Add tutorial to show interactive data visualization via 'panel'

[yvonnefroehlich]

Description of proposed changes

This PR aims to add a tutorial showing how to use the library panel to create an interactive dashboard with PyGMT.

• static map
• dynamic map
• add a grid, e.g., earth_relief ?
• add panel as a dependency
• write nice documentation

The tutorial is based on this EGU 2022 Short Course example and #2455 (comment)

A global map with varying central longitude (similar to this animation https://docs.generic-mapping-tools.org/latest/animations/anim07.html but coastlines are enough)

Fixes #2455

Preview: https://pygmt-dev--2498.org.readthedocs.build/en/2498/tutorials/advanced/working_with_panel.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.
• 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 commands are:

• /format: automatically format and lint the code
• /test-gmt-dev: run full tests on the latest GMT development version

[yvonnefroehlich]

/format

[seisman]

Looks good to me except one minor comment.

[weiji14]

The EGU 2022 example shows an image with a slider (although it's static),
but in this example, it shows nothing:
Maybe some panel configurations are missing?

I think this is because the EGU 2022 example is a Jupyter notebook, but this example is a normal Python script.

Is there a sphinx extension or something to have the slider show up? I feel like there should be some way...

[michaelgrund]

Looks good to me except the comment of @weiji14. If it would be possible to show the slider in some way this would be great. Apart from that, great work @yvonnefroehlich.

[seisman]

The EGU 2022 example shows an image with a slider (although it's static),
but in this example, it shows nothing:
Maybe some panel configurations are missing?

I think this is because the EGU 2022 example is a Jupyter notebook, but this example is a normal Python script.

Is there a sphinx extension or something to have the slider show up? I feel like there should be some way...

I don't think it's possible with our current docs settings.

When we build the docs, the Sphinx-Gallery plugin executes the .py gallery script and captures the outputs. Then it converts the .py script and the output into a ReST file, and also converts the .py script into a Jupyter Notebook. The generated ReST file is included as part of the Sphinx documentation and is rendered into an HTML file.

Thus, the main problem is that Sphinx-Gallery can't capture the "slider" generated by Panel.

[seisman]

The EGU 2022 example shows an image with a slider (although it's static),
but in this example, it shows nothing:
Maybe some panel configurations are missing?

I think this is because the EGU 2022 example is a Jupyter notebook, but this example is a normal Python script.

Is there a sphinx extension or something to have the slider show up? I feel like there should be some way...

Maybe we can add some screenshots (with the slider) as a workaround.

[seisman]

The EGU 2022 example shows an image with a slider (although it's static),
but in this example, it shows nothing:
Maybe some panel configurations are missing?

I think this is because the EGU 2022 example is a Jupyter notebook, but this example is a normal Python script.

Is there a sphinx extension or something to have the slider show up? I feel like there should be some way...

I don't think it's possible with our current docs settings.

When we build the docs, the Sphinx-Gallery plugin executes the .py gallery script and captures the outputs. Then it converts the .py script and the output into a ReST file, and also converts the .py script into a Jupyter Notebook. The generated ReST file is included as part of the Sphinx documentation and is rendered into an HTML file.

Thus, the main problem is that Sphinx-Gallery can't capture the "slider" generated by Panel.

@weiji14 Any more comments?

[weiji14]

Ok to merge first, we can see if there's a way to show the slider later.