Skip to article frontmatterSkip to article content
Site not loading correctly?

This may be due to an incorrect BASE_URL configuration. See the MyST Documentation for reference.

Jupyter notebook

🚧 Page under construction 🚧

What are Jupyter notebooks useful for?

Jupyter notebooks are useful not only to draft code, but also to create use cases, demos, or examples for Python packages.

How do I structure a Jupyter notebook?

We created a Jupyter notebook template that you can download [here](ORMIR_nb_template.ipynb. Just like when you write a paper, you fill out a journal template with your content, you can fill out the ORMIR community notebook template with your narrative and code.

Why should I use the template? We usually use notebooks to create use-cases for our Python packages. Using the template allows us to harmonize our use-cases and to make sure we remember to include authors, licenses, references, etc.

ORMIR Code Guidelines
🐍 Coding in Python
ORMIR Code Guidelines
📚 Documentation