Skip to main content

Pyxel detector simulation framework.

Project description

Pyxel detector simulation framework

doi ASCL docs gitter Google Group License PyPI version conda Binder pipeline status coverage report Code style: black JSON Schema Static Badge

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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pyxel_sim-2.4.tar.gz (815.0 kB view details)

Uploaded Source

Built Distribution

pyxel_sim-2.4-py3-none-any.whl (924.1 kB view details)

Uploaded Python 3

File details

Details for the file pyxel_sim-2.4.tar.gz.

File metadata

  • Download URL: pyxel_sim-2.4.tar.gz
  • Upload date:
  • Size: 815.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.11.8

File hashes

Hashes for pyxel_sim-2.4.tar.gz
Algorithm Hash digest
SHA256 ec2e4fa219b8783ddce7a0478d78a8f870bc7abaeb74a3452590724ba6e6df23
MD5 053b732a7e2116e0b772021e948eadbd
BLAKE2b-256 4c92631e83f95e1614e177bdb28f336dc9846058be8bba9e1040a6c8b7d03bd4

See more details on using hashes here.

File details

Details for the file pyxel_sim-2.4-py3-none-any.whl.

File metadata

  • Download URL: pyxel_sim-2.4-py3-none-any.whl
  • Upload date:
  • Size: 924.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.11.8

File hashes

Hashes for pyxel_sim-2.4-py3-none-any.whl
Algorithm Hash digest
SHA256 0fba83fb1f4405b5fd1c45558ec03e9d315c458b3bc8a5ea4c631a5022d92ccf
MD5 512e61400bf0c5f6b26929116b143297
BLAKE2b-256 774c9a51be2f29ab1b664043e16659469ba36bfaa7ff1fb0b42a96c178c20484

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page