Welcome to the Pyxel Tutorials and Examples !

Pyxel is a user-friendly general detector simulation framework.

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 this public repository. Please note, that this Jupyter book page 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 install 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

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:

Tutorials

• 1. Introduction
• 2. First simulation with Pyxel
• 3. Pyxel configuration and classes
• 4. Create a new model
• 5. Observation mode
• 6. Calibration mode
• 7. Calibration mode - visualization of results
• 8. Exposure mode with multiple readout times

Examples

• Exposure
  • Exposure mode
  • Running Pyxel
  • Exposure with persistence
• Observation
  • Observation - Product
  • Observation - Sequential
  • Observation - Custom
  • Observation mode with parallel computing - eclipse
• Calibration
  • Calibration CDM irradiated image pipeline with Pyxel
• Models
  • Amplifier crosstalk model
  • Inter-pixel capacitance model
  • Dark current versus temperature for silicon detectors
  • Observation mode
  • Plotting the outputs
  • Dark current vs temperature for MCT detectors
  • Simulating radiation induced dark current
  • Extract Region of Interest(s)
  • Data processing models: Exposure mode
  • Data processing models: Observation mode
  • Non-linearity
  • EMCCD Observation Mode
  • Scene generation and projection

Use cases

• Multi-wavelength capability
• APD
  • Saphira
  • Saphira vs. avalanche gain
• CCD
• CMOS
• Simulating the ARIEL AIRS detector
• H2RG pipeline
• Euclid CCD Photon Transfer Curve
• Euclid Charge Transfer Inefficiency
  • Calibration ArCTIc irradiated image pipeline with Pyxel
  • Data analysis notebook to produce all graphs
  • Data analysis notebook to produce all graphs
  • Data analysis notebook to produce all graphs
  • Functions
  • Get profiles
  • Reduced chi squared calc
  • 1D corrections
  • 2D corrections
  • Getting input data
  • Exposure mode
  • functions
  • open filenames
  • Functions
  • Saving images

Workshops

• 🇳🇱 Developer Workshop 2024 at ESTEC
• 🇯🇵Pyxel workshop 2024 at SPIE
• CMOS Workshop 2022
  • Introduction
  • First simulation with Pyxel
  • Dark current versus temperature for silicon detectors
  • Observation mode
  • Plotting the outputs
  • Charge transfer ineffiency
  • Create a new model
• Leiden University Workshop
  • First simulation with Pyxel
  • Photon transfer curve