Skip to content
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

Merged
merged 3 commits into from
Dec 8, 2017
Merged

Tutorials: Binder #182

merged 3 commits into from
Dec 8, 2017

Conversation

ax3l
Copy link
Member

@ax3l ax3l commented Dec 2, 2017

Enables Binder 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.

@ax3l ax3l added the tutorial label Dec 2, 2017
@ax3l ax3l requested a review from RemiLehe December 2, 2017 00:56
Copy link
Member

@RemiLehe RemiLehe left a 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).
Copy link
Member

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.

Copy link
Member Author

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.

@RemiLehe
Copy link
Member

RemiLehe commented Dec 8, 2017

Thanks for updating the PR!

@RemiLehe RemiLehe merged commit 31e0ea1 into openPMD:dev Dec 8, 2017
@ax3l ax3l deleted the topic-binder branch December 8, 2017 08:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants