Version 2 is released ! 🚀

Welcome to the Pyxel documentation !

Welcome to the Pyxel documentation !#

Pyxel is a general detector simulation framework.

An easy-to-use framework that can simulate a variety of imaging detector effects combined on images (e.g. radiation and optical effects, noises) made by CCD or CMOS-based detectors.

Version: 2.1.1

Useful links: Webpage and blog | Source repository | Example repository

How the documentation is organized#

A high-level overview of how the documentation is organized will help you known where to look for certain things:

Getting started

Getting started section takes you by the hand through a series of steps on how to install and how to use Pyxel. Contains a tutorial and multiple examples. Start here if you’re new to Pyxel.

How-to guides

How-to guides are recipes. They guide you through the steps involved in addressing the key problems and use-cases. They are more advanced than tutorials and assume some knowledge of how Pyxel works.

Background

Background section discusses and explains key topics and concepts at a fairly high level and provides useful background information.

Reference

Reference guides contain technical reference for APIs, models and other aspects of Pyxel. They describe how it works and how to use it but assume that you have a basic understanding of key concepts.