pyxel-sim 2.5

Pyxel detector simulation framework.

Pyxel detector simulation framework

What is it?

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.

Pyxel is tested on Python 3.9+.

If you'd like to contribute to Pyxel you're most welcome. Please read the little guide to get you started.

Documentation

Learn more about Pyxel in its offical blog and its official documentation at https://esa.gitlab.io/pyxel/doc.

Quickstart Setup

The best way to get started and learn Pyxel are the Tutorials and Examples.

For convenience we provide a pre-defined conda environment file, so you can get additional useful packages together with Pyxel in a virtual isolated environment.

For more information check the Quickstart Setup instructions.

Installation

Installation instructions can be found in the tutorials.

Examples

Example notebooks of Pyxel can be found in a separate public repository Pyxel Data. Examples can either be downloaded and run locally or run in the cloud using Binder, by clicking on the badge above.

Getting Help

• Report bugs, suggest features or view the source code on GitLab.
• For less well-defined questions or ideas, or to announce other projets of interest to Pyxel users, use the Pyxel mailing list.

Discussion and Development

Most development discussion is taking place on GitLab in this repo. Further, the Pyxel mailing list can also be used for specialized discussions or design issues, and a Gitter channel is available for quick development related questions.

Citing Pyxel

If you use Pyxel, please cite the paper we published in SPIE Digital Library.

Contributing to Pyxel

All contributions, bug reports, bug fixes, documentation improvements, enhancements and ideas are welcome.

A detailed overview on how to contribute to Pyxel can be found in the contributing guide. There is also an overview on GitLab.

If you are simply looking to start working with the Pyxel codebase, navigate to the GitLab "issues" tab and start looking through interesting issues. There are a number of issues listed under Docs and good first issue where you could start out.

Or maybe through using Pyxel you have an idea of your own or are looking for something in the documentation and thinking 'this can be improved'... you can do something about it !

Feel free to ask questions on the mailing list or on Gitter.

Changelog

The detailed changelog is available on the website.

License

Pyxel is released under MIT license.