Pyxel detector simulation framework
===================================
[](https://doi.org/10.1117/1.JATIS.8.4.048002)
[](https://ascl.net/2301.002)
[](https://esa.gitlab.io/pyxel/doc)
[](https://gitter.im/pyxel-framework/community)
[](https://groups.google.com/g/pyxel-detector-framework)
[](https://gitlab.com/esa/pyxel/blob/master/LICENSE.txt)
[](https://badge.fury.io/py/pyxel-sim)
[](https://anaconda.org/conda-forge/pyxel-sim)
[](https://mybinder.org/v2/gl/esa%2Fpyxel-data/HEAD?urlpath=lab)
[](https://gitlab.com/esa/pyxel/-/pipelines)
[](https://esa.gitlab.io/pyxel/htmlcov/)
[](https://github.com/psf/black)
[](https://esa.gitlab.io/pyxel/pyxel_schema.json)
[](https://esa.gitlab.io/pyxel/doc/stable/references/contributing.html)
## 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](https://esa.gitlab.io/pyxel/doc/stable/references/contributing.html) to get you started.
## Documentation
Learn more about *Pyxel* in its offical [blog](https://esa.gitlab.io/pyxel) and its official documentation at [https://esa.gitlab.io/pyxel/doc](https://esa.gitlab.io/pyxel/doc).
## Quickstart Setup
The best way to get started and learn Pyxel are the [Tutorials and Examples](https://esa.gitlab.io/pyxel/doc/stable/tutorials/examples.html).
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](https://esa.gitlab.io/pyxel/doc/stable/tutorials/overview.html#quickstart-setup) instructions.
## Installation
[Installation instructions](https://esa.gitlab.io/pyxel/doc/stable/tutorials/install.html) can be found in the tutorials.
## Examples
Example notebooks of Pyxel can be found in a separate public repository [Pyxel Data](https://gitlab.com/esa/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](https://gitlab.com/esa/pyxel).
* For less well-defined questions or ideas, or to announce other projets of interest to Pyxel users, use the *Pyxel* [mailing list](https://groups.google.com/g/pyxel-detector-framework).
## Discussion and Development
Most development discussion is taking place on GitLab in this repo.
Further, the *Pyxel* [mailing list](https://groups.google.com/g/pyxel-detector-framework) can also be used for specialized discussions or design issues, and a [Gitter channel](https://gitter.im/pyxel-framework/community) is available for quick development related questions.
## Citing Pyxel
If you use *Pyxel*, please cite the paper we published in [SPIE Digital Library](https://www.spiedigitallibrary.org/journals/Journal-of-Astronomical-Telescopes-Instruments-and-Systems/volume-8/issue-04/048002/Pyxel-10--an-open-source-Python-framework-for-detector/10.1117/1.JATIS.8.4.048002.full?SSO=1).
## 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**](https://esa.gitlab.io/pyxel/doc/stable/references/contributing.html).
There is also an [overview](.gitlab/CONTRIBUTING.md) on GitLab.
If you are simply looking to start working with the *Pyxel* codebase, navigate to the
[GitLab "issues" tab](https://gitlab.com/esa/pyxel/issues) and start looking through interesting issues.
There are a number of issues listed under [Docs](https://gitlab.com/esa/pyxel/issues?label_name%5B%5D=documentation) and [good first issue](https://gitlab.com/esa/pyxel/issues?label_name%5B%5D=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](https://groups.google.com/g/pyxel-detector-framework) or on [Gitter](https://gitter.im/pyxel-framework/community).
## Changelog
The [detailed changelog](https://esa.gitlab.io/pyxel/doc/stable/references/changelog.html) is available on the website.
## License
*Pyxel* is released under [MIT license](https://gitlab.com/esa/pyxel/blob/master/LICENSE.txt).
Raw data
{
"_id": null,
"home_page": "",
"name": "pyxel-sim",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": "",
"keywords": "ESA,data modeling,sensors,calibration,CCD,CMOS,active sensors,electronics",
"author": "",
"author_email": "The Pyxel development team <pyxel@esa.int>",
"download_url": "https://files.pythonhosted.org/packages/b5/63/6bf5aef3a65b84f734e00ef020f2ee78eb0801179890bbfbf0b7ae7e6575/pyxel_sim-2.1.1.tar.gz",
"platform": null,
"description": "Pyxel detector simulation framework\n===================================\n\n[](https://doi.org/10.1117/1.JATIS.8.4.048002)\n[](https://ascl.net/2301.002)\n[](https://esa.gitlab.io/pyxel/doc)\n[](https://gitter.im/pyxel-framework/community)\n[](https://groups.google.com/g/pyxel-detector-framework)\n[](https://gitlab.com/esa/pyxel/blob/master/LICENSE.txt)\n[](https://badge.fury.io/py/pyxel-sim)\n[](https://anaconda.org/conda-forge/pyxel-sim)\n[](https://mybinder.org/v2/gl/esa%2Fpyxel-data/HEAD?urlpath=lab)\n[](https://gitlab.com/esa/pyxel/-/pipelines)\n[](https://esa.gitlab.io/pyxel/htmlcov/)\n[](https://github.com/psf/black)\n[](https://esa.gitlab.io/pyxel/pyxel_schema.json)\n[](https://esa.gitlab.io/pyxel/doc/stable/references/contributing.html)\n\n## What is it?\n\n*Pyxel* is a general detector simulation framework.\nAn easy-to-use framework that can simulate a variety of imaging detector\neffects combined on images (e.g. radiation and optical effects, noises)\nmade by CCD or CMOS-based detectors.\n\n*Pyxel* is tested on Python 3.9+.\n\nIf you'd like to contribute to *Pyxel* you're most welcome.\nPlease read [the little guide](https://esa.gitlab.io/pyxel/doc/stable/references/contributing.html) to get you started.\n\n## Documentation\n\nLearn more about *Pyxel* in its offical [blog](https://esa.gitlab.io/pyxel) and its official documentation at [https://esa.gitlab.io/pyxel/doc](https://esa.gitlab.io/pyxel/doc).\n\n## Quickstart Setup\n\nThe best way to get started and learn Pyxel are the [Tutorials and Examples](https://esa.gitlab.io/pyxel/doc/stable/tutorials/examples.html).\n\nFor convenience we provide a pre-defined conda environment file,\nso you can get additional useful packages together with Pyxel in a virtual isolated environment.\n\nFor more information check the [Quickstart Setup](https://esa.gitlab.io/pyxel/doc/stable/tutorials/overview.html#quickstart-setup) instructions.\n \n## Installation\n\n[Installation instructions](https://esa.gitlab.io/pyxel/doc/stable/tutorials/install.html) can be found in the tutorials.\n\n## Examples\n\nExample notebooks of Pyxel can be found in a separate public repository [Pyxel Data](https://gitlab.com/esa/pyxel-data). Examples can either be downloaded and run locally or run in the cloud using Binder, by clicking on the badge above.\n\n\n## Getting Help\n\n\n* Report bugs, suggest features or view the source code on [GitLab](https://gitlab.com/esa/pyxel).\n* For less well-defined questions or ideas, or to announce other projets of interest to Pyxel users, use the *Pyxel* [mailing list](https://groups.google.com/g/pyxel-detector-framework).\n\n## Discussion and Development\n\nMost development discussion is taking place on GitLab in this repo.\nFurther, the *Pyxel* [mailing list](https://groups.google.com/g/pyxel-detector-framework) can also be used for specialized discussions or design issues, and a [Gitter channel](https://gitter.im/pyxel-framework/community) is available for quick development related questions.\n\n\n## Citing Pyxel\n\nIf you use *Pyxel*, please cite the paper we published in [SPIE Digital Library](https://www.spiedigitallibrary.org/journals/Journal-of-Astronomical-Telescopes-Instruments-and-Systems/volume-8/issue-04/048002/Pyxel-10--an-open-source-Python-framework-for-detector/10.1117/1.JATIS.8.4.048002.full?SSO=1).\n\n## Contributing to *Pyxel*\n\nAll contributions, bug reports, bug fixes, documentation improvements, enhancements and ideas are welcome.\n\nA detailed overview on how to contribute to *Pyxel* can be found in the\n[**contributing guide**](https://esa.gitlab.io/pyxel/doc/stable/references/contributing.html).\nThere is also an [overview](.gitlab/CONTRIBUTING.md) on GitLab.\n\nIf you are simply looking to start working with the *Pyxel* codebase, navigate to the\n[GitLab \"issues\" tab](https://gitlab.com/esa/pyxel/issues) and start looking through interesting issues.\nThere are a number of issues listed under [Docs](https://gitlab.com/esa/pyxel/issues?label_name%5B%5D=documentation) and [good first issue](https://gitlab.com/esa/pyxel/issues?label_name%5B%5D=good+first+issue) where you could start out.\n\nOr 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 !\n\nFeel free to ask questions on the [mailing list](https://groups.google.com/g/pyxel-detector-framework) or on [Gitter](https://gitter.im/pyxel-framework/community).\n\n\n## Changelog\n\nThe [detailed changelog](https://esa.gitlab.io/pyxel/doc/stable/references/changelog.html) is available on the website.\n\n\n## License\n\n*Pyxel* is released under [MIT license](https://gitlab.com/esa/pyxel/blob/master/LICENSE.txt).\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Pyxel detector simulation framework.",
"version": "2.1.1",
"project_urls": {
"changelog": "https://gitlab.com/esa/pyxel/-/releases",
"documentation": "https://esa.gitlab.io/pyxel/doc/",
"homepage": "https://esa.gitlab.io/pyxel/",
"repository": "https://gitlab.com/esa/pyxel",
"tracker": "https://gitlab.com/esa/pyxel/issues"
},
"split_keywords": [
"esa",
"data modeling",
"sensors",
"calibration",
"ccd",
"cmos",
"active sensors",
"electronics"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "6204b6601b027a44c83a2870f8bd25c25637c4103052d43ea5a465d8d41564c5",
"md5": "3893181cb242f3fda06235fa08aa62a4",
"sha256": "63d46aa727781f83743f91f8139ce9b4d7e5ef36cbe0044f540758882846ea20"
},
"downloads": -1,
"filename": "pyxel_sim-2.1.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "3893181cb242f3fda06235fa08aa62a4",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 913856,
"upload_time": "2024-03-18T14:24:46",
"upload_time_iso_8601": "2024-03-18T14:24:46.991765Z",
"url": "https://files.pythonhosted.org/packages/62/04/b6601b027a44c83a2870f8bd25c25637c4103052d43ea5a465d8d41564c5/pyxel_sim-2.1.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "b5636bf5aef3a65b84f734e00ef020f2ee78eb0801179890bbfbf0b7ae7e6575",
"md5": "f7cf50d9bb63af4723329e03a20e8759",
"sha256": "9477ec1f47c6a619b541e21daa6dca708116078ed2b61687413d01485fd4c47f"
},
"downloads": -1,
"filename": "pyxel_sim-2.1.1.tar.gz",
"has_sig": false,
"md5_digest": "f7cf50d9bb63af4723329e03a20e8759",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 806065,
"upload_time": "2024-03-18T14:24:49",
"upload_time_iso_8601": "2024-03-18T14:24:49.672316Z",
"url": "https://files.pythonhosted.org/packages/b5/63/6bf5aef3a65b84f734e00ef020f2ee78eb0801179890bbfbf0b7ae7e6575/pyxel_sim-2.1.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-18 14:24:49",
"github": false,
"gitlab": true,
"bitbucket": false,
"codeberg": false,
"gitlab_user": "esa",
"gitlab_project": "pyxel",
"lcname": "pyxel-sim"
}
JSON