Template#
short description: what can be learned from this example?
A longer description of what this example is about.
The data#
Data file |
Type |
Download |
Courtesy of |
Reference |
---|---|---|---|---|
filename |
Raw/Reconstruction etc. |
Who to credit for providing the data |
Add a more detailed description of the data here, i.e. dimensions, meta parameters etc.
Main body of tutorial#
Anything that adds value to this user example, i.e. background theory, highlighting certain parameters, explaining methods or pipelines, discussing challenges etc.
You can use the MyST makrdown syntax, check this cheatsheet as a reference.
Admonitions#
The MyST syntax comes with admonitions which can be useful to highlight certain things and give hints to users. To also render those admonitions nicely in plain jupyter notebooks, please use on of the following templates below. They use HTML which also renders in Jupyter notebooks, but when published they are converted to MyST admonitions by the Github actions pipeline.
Tip
Something useful
Note
A note with
some code
inside and more code
inline.
Challenge
Provide some ideas for playing with and exploring this examples.
Images#
For displaying any images, just upload into the _assets folder and then use
![](./_assets/some_image.png)
# Add full code of PtyPy run script here
# ...