Tutorials

Here you can find tutorials that explain how to use prfmodel. Stay tuned because more tutorials are in the making.

You want to contribute a tutorial? Make a pull request!

List of tutorials:

Tutorial development

Tutorials are stored in the MyST Markdown format. They are automatically rendered by Sphinx in the local and online documentation. However, for development purposes, it can be useful to locally convert the MyST Markdown files into Jupyter notebooks (and vice versa). The conversion can be done with jupytext.

To locally convert MyST Markdown files into Jupyter notebooks:

jupytext docs/tutorials/tutorial.ipynb --to myst

To locally convert Jupyter notebooks into MyST Markdown files:

jupytext docs/tutorials/tutorial.md --to ipynb