-
Notifications
You must be signed in to change notification settings - Fork 50
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Tutorials: Binder #182
Tutorials: Binder #182
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks a lot for this PR! This would be very useful. I have one minor comment (see inline).
README.md
Outdated
@@ -23,9 +24,12 @@ visualize the data. | |||
|
|||
### Tutorials | |||
|
|||
The notebooks in the folder `tutorials/` demonstrate how to use both | |||
the API and the interactive GUI. You can view these notebooks online | |||
[here](https://github.com/openPMD/openPMD-viewer/tree/master/tutorials). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I would still keep the paragraph
The notebooks in the folder `tutorials/` demonstrate how to use both
the API and the interactive GUI. You can view these notebooks online
[here](https://github.com/openPMD/openPMD-viewer/tree/master/tutorials).
and only add the paragraph
Alternatively you can even [run this tutorials online](https://mybinder.org/v2/gh/openPMD/openPMD-viewer/master?filepath=tutorials%2F)!
The main reason is that, in my experience, Binder is often down, (see e.g. here) and so the user should have an easy way to still see the tutorials if this happens.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
good point, updated the PR accordingly.
Thanks for updating the PR! |
Enables support for our tutorials.
With binder, our users can quickly expore the features of openPMD-viewer online - without the need to install anything. It's just amazing.