Add tutorial to show interactive data visualization via 'panel' by yvonnefroehlich · Pull Request #2498 · GenericMappingTools/pygmt

yvonnefroehlich · 2023-04-16T08:15:19Z

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.

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 · 2023-04-16T08:22:39Z

/format

pyproject.toml

doc/install.rst

examples/tutorials/advanced/panel_extension.py

environment.yml

examples/tutorials/advanced/panel_extension.py

Co-authored-by: Wei Ji <23487320+weiji14@users.noreply.github.com>

Co-authored-by: Dongdong Tian <seisman.info@gmail.com>

examples/tutorials/advanced/working_with_panel.py

seisman

Looks good to me except one minor comment.

Co-authored-by: Dongdong Tian <seisman.info@gmail.com>

weiji14 · 2023-04-27T01:13:38Z

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 · 2023-04-28T02:15:56Z

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 · 2023-04-28T02:16:58Z

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 · 2023-05-01T07:14:25Z

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 · 2023-05-01T07:16:25Z

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

yvonnefroehlich added 2 commits April 16, 2023 09:56

Add basic code for tutorial showing the 'panel'

f3e496b

Remove section 'Add a grid'

8e0e0dd

yvonnefroehlich added the documentation Improvements or additions to documentation label Apr 16, 2023

yvonnefroehlich added this to the 0.10.0 milestone Apr 16, 2023

yvonnefroehlich self-assigned this Apr 16, 2023

Fix code style - add blank line

9274b85

actions-bot and others added 3 commits April 16, 2023 08:23

[format-command] fixes

0133512

Adjust thumbnail_number

d55d7cf

Add 'panel' as a dependency

dccdf74

yvonnefroehlich changed the title ~~Add tutorial to show usage of 'panel' for interactive data visualization~~ WIP: Add tutorial to show usage of 'panel' for interactive data visualization Apr 16, 2023

yvonnefroehlich marked this pull request as draft April 16, 2023 10:57

yvonnefroehlich added 3 commits April 16, 2023 19:05

Add 'panel' as dependency

fdf180e

Fix typos

8a50bde

Add missing comma

b548efa

yvonnefroehlich changed the title ~~WIP: Add tutorial to show usage of 'panel' for interactive data visualization~~ WIP: Add tutorial to show interactive data visualization via 'panel' Apr 16, 2023

yvonnefroehlich added 8 commits April 16, 2023 19:26

Fix highlighting

c5d3e82

Fix link

5149655

Improve docs

28a72df

Add more docs

bde882b

Adjust thubnail_number

3919f03

Add code for third part (add grid)

b046aac

Fix coding style

c9b213e

Remove blank line

a4c7c2a

yvonnefroehlich mentioned this pull request Apr 16, 2023

Add an gallery example/tutorial for interactive data visualization using Panel? #2455

Closed

weiji14 reviewed Apr 16, 2023

View reviewed changes

pyproject.toml Outdated Show resolved Hide resolved

doc/install.rst Outdated Show resolved Hide resolved

examples/tutorials/advanced/panel_extension.py Outdated Show resolved Hide resolved

seisman reviewed Apr 17, 2023

View reviewed changes

environment.yml Outdated Show resolved Hide resolved

examples/tutorials/advanced/panel_extension.py Outdated Show resolved Hide resolved

yvonnefroehlich and others added 3 commits April 17, 2023 09:18

Do not include 'panel' as an optional dependency in 'pyproject.py'

1cec47e

Co-authored-by: Wei Ji <23487320+weiji14@users.noreply.github.com>

Do not include 'panel' as an optional dependency in 'install.rst'

55b7203

Co-authored-by: Wei Ji <23487320+weiji14@users.noreply.github.com>

Improve link to 'panel'

0f25508

yvonnefroehlich and others added 3 commits April 25, 2023 08:55

Calculate min and max without numpy

d830c28

Co-authored-by: Dongdong Tian <seisman.info@gmail.com>

Adjust building string for projection argument

f3431e0

Co-authored-by: Dongdong Tian <seisman.info@gmail.com>

Adjust building string for projection argument

40589ec

Co-authored-by: Dongdong Tian <seisman.info@gmail.com>

yvonnefroehlich changed the title ~~WIP: Add tutorial to show interactive data visualization via 'panel'~~ Add tutorial to show interactive data visualization via 'panel' Apr 25, 2023

yvonnefroehlich marked this pull request as ready for review April 25, 2023 06:59

Remove white spaces around "/"

3e3ea36

Co-authored-by: Dongdong Tian <seisman.info@gmail.com>

seisman reviewed Apr 25, 2023

View reviewed changes

examples/tutorials/advanced/working_with_panel.py Outdated Show resolved Hide resolved

examples/tutorials/advanced/working_with_panel.py Outdated Show resolved Hide resolved

yvonnefroehlich added 6 commits April 25, 2023 09:56

Update file name in introduction

ea81b1d

Fix length of underline of title

c3fd8e7

Adjust 'series' parameter of 'makecpt'

fe456aa

Fix line length

49c0eb2

Remove file name in introduction

0e6ef65

Fix coding style - 'series' argument seems to fit in one line

68ba2e5

seisman reviewed Apr 25, 2023

View reviewed changes

examples/tutorials/advanced/working_with_panel.py Outdated Show resolved Hide resolved

seisman added final review call This PR requires final review and approval from a second reviewer and removed needs review This PR has higher priority and needs review. labels Apr 25, 2023

seisman approved these changes Apr 25, 2023

View reviewed changes

Remove 'r' at the beginning of the docstrings (code review)

71ddb12

Co-authored-by: Dongdong Tian <seisman.info@gmail.com>

seisman requested review from michaelgrund and weiji14 April 27, 2023 00:27

michaelgrund approved these changes Apr 27, 2023

View reviewed changes

seisman merged commit bdf5b1e into main May 1, 2023

seisman deleted the add-tutorial-panel branch May 1, 2023 07:39

seisman removed the final review call This PR requires final review and approval from a second reviewer label May 1, 2023

yvonnefroehlich mentioned this pull request Oct 10, 2023

POC: Panel tutorial: Add static image with slider for thumbnail image #2736

Closed

7 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add tutorial to show interactive data visualization via 'panel'#2498

Add tutorial to show interactive data visualization via 'panel'#2498
seisman merged 54 commits intomainfrom
add-tutorial-panel

yvonnefroehlich commented Apr 16, 2023 •

edited

Loading

Uh oh!

yvonnefroehlich commented Apr 16, 2023

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

seisman left a comment

Uh oh!

weiji14 commented Apr 27, 2023

Uh oh!

michaelgrund left a comment

Uh oh!

seisman commented Apr 28, 2023

Uh oh!

seisman commented Apr 28, 2023

Uh oh!

seisman commented May 1, 2023

Uh oh!

weiji14 commented May 1, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

Conversation

yvonnefroehlich commented Apr 16, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

yvonnefroehlich commented Apr 16, 2023

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

seisman left a comment

Choose a reason for hiding this comment

Uh oh!

weiji14 commented Apr 27, 2023

Uh oh!

michaelgrund left a comment

Choose a reason for hiding this comment

Uh oh!

seisman commented Apr 28, 2023

Uh oh!

seisman commented Apr 28, 2023

Uh oh!

seisman commented May 1, 2023

Uh oh!

weiji14 commented May 1, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

yvonnefroehlich commented Apr 16, 2023 •

edited

Loading