Tutorials

These tutorials are implemented as Jupyter notebooks meaning that, while they appear as ordinary HTML documents here, you can also run them interactively. The notebooks are found in doc/tutorials folder in your cloned repository. To run them interactively, you need to have Jupyter installed and then configure it to use the virtual environment that you’ve created when installing ASCOT5:

pip install jupyter
ipython kernel install --user --name=ascotenv

Now you can run the examples interactively with e.g. VS Code, or even with your browser (remember to select the ascotenv kernel),

jupyter-notebook

or you can convert these examples to ordinary Python scripts and execute them (executing them in ipython terminal is advised as otherwise the plotted figures close immediately):

jupyter-nbconvert --to python <name of the notebook e.g. tutorial.ipynb>
python tutorial.py

Basics

Marker generation

Physics

Tools