Tutorials and examples#
We recommend you to start with the tutorial available in the form of Jupyter notebooks. It covers all the basics, the four running modes and adding a new model. Apart from the tutorial, more examples on running modes and different models are also available. See below for a full list.
All tutorials and examples can be found in a separate public repository Pyxel Data, to access the corresponding Jupyter book click on the link below. Please note, that the Jupyter book is just for viewing the examples and not interactive.
If you want to change the inputs and see the results immediately, you need to a Installation of Pyxel and download the Pyxel Data repository or launch a live session on Binder.
Once you’ve installed Pyxel, the example repository can be either downloaded directly by clicking on button download or using Pyxel by running the command:
pyxel download-examples
or
python -m pyxel download-examples
Now you can launch JupyterLab to explore them:
cd pyxel-examples
jupyter lab
You can run also tutorials and examples without prior installation of Pyxel in a live session here: 
Generic detector pipelines#
The Pyxel model library contains models for various types of detectors. Not all models can be used with all of the detector types and some specific models are only to be used with a single type of detector. For this reason and to help new users and non-experts, generic configuration file templates for different detectors have been included in the Pyxel Data example repository, together with corresponding Jupyter notebooks. They include detector properties and pipelines with detector-appropriate sets of models, pre-filled with realistic model argument values. They provide a good starting point for simulations of specific detectors and later customization or iteration with detector engineers and experts. The generic pipelines are now available for the following types of detectors: generic CCD, generic CMOS, Teledyne HxRG, Microwave kinetic-inductance detector (MKID) and Avalanche Photo Diode (APD) array detector based on Leonardo’s Saphira detector.