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

Add support for rendering Jupyter notebooks #25

Open
jchodera opened this issue Sep 2, 2017 · 3 comments
Open

Add support for rendering Jupyter notebooks #25

jchodera opened this issue Sep 2, 2017 · 3 comments

Comments

@jchodera
Copy link
Member

jchodera commented Sep 2, 2017

I have prepared some Jupyter notebooks to help MD practitioners new to OpenMM get started:
https://github.com/choderalab/openmm-tutorials

It would be great to include these in the OpenMM Tutorials page.

One approach is to use jupyter nbconvert to convert them to Markdown, but this loses a lot of formatting of the output cells and graphical displays.

An alternative might be to add jekyll-jupyter-notebook support to the Jekyll static site renderer and just include the notebooks directly.

@raimis
Copy link

raimis commented May 31, 2021

@Yoshanuikabundi idea from #45 (comment)

Using Binder rather than Colab might be a solution to this. We cache the environment so that it loads quickly (much, much faster than installing via Conda) and doesn't have to include installation instructions, and we could convert the notebook to static HTML and embed it directly in the home page (or wherever). That way we can use our own theming and CSS, it doesn't have to look like a notebook at all. When a user wants to run their own code, they click a button that loads up the Binder notebook and have a fully installed system ready to go.

I'm working on something similar for OpenFF. You can see here that static web pages made from notebooks can render interactive widgets if prepared properly. Having an interactive 3D model of a prepared system ready to simulate might be more exciting than installation instructions :)

@raimis raimis mentioned this issue May 31, 2021
@raimis
Copy link

raimis commented Aug 9, 2021

The best I can found for rendering Jupyter notebooks is https://github.com/jsvine/notebookjs. They have a demo to try https://jsvine.github.io/nbpreview/.

This should be sufficient for #66.

@peastman
Copy link
Member

peastman commented Aug 9, 2021

That looks nice.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants