Tutorials & Examples¶
Here you can find tutorials and examples that explain how to use prfmodel. Tutorials are shorter and explain specific features of prfmodel while examples are longer and contain end-to-end applications of the package. Stay tuned because more tutorials and examples are in the making.
You want to contribute a tutorial or example? Make a pull request!
Development¶
Tutorials and examples 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.md --to ipynb
To locally convert Jupyter notebooks into MyST Markdown files:
jupytext docs/tutorials/tutorial.ipynb --to myst