| Name | emccd-detect JSON |
| Version |
2.5.0
JSON |
| download |
| home_page | None |
| Summary | EMCCD detector image simulation |
| upload_time | 2025-09-11 23:48:19 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.6 |
| license | None |
| keywords |
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# EMCCD Detect
Given an input fluxmap, emccd_detect will return a simulated EMCCD detector image. Website: (<https://github.com/roman-corgi/emccd_detect/tree/master/emccd_detect>)
# Version
The latest version of emccd\_detect is 2.5.0. Main differences from previous version, 2.4.0:
--the ability to implement smear due to exposure of some rows while others are being read out. Credit for this smearing code: Peter Williams, Tellus1, 2024.
--the ability to implement non-uniformity in pixel response via an input master flat. Assumed to be a FITS file.
## Getting Started
### Installing
This package requires Python version 3.6 or higher. If the user wants the ability to apply charge transfer inefficiency (CTI) to detector frames using the optional tool (older version of arcticpy which is pure Python) provided in emccd\_detect, then the Python version should be >=3.6 and <=3.9. If the newer version of arcticpy (wrapper around C++ code) is installed, there is no upper limit restriction for Python version. For installation instructions and documentation for the newer arcticpy, see <https://github.com/jkeger/arctic>. emccd\_detect works apart from arcticpy and does not require it.
emccd\_detect is available on PyPI.org, so the following command will install the module (without CTI capabilities):
pip install emccd-detect
To install emccd\_detect instead from this package download, after downloading, navigate to the emccd\_detect directory where setup.py is located and use
pip install .
This will install emccd\_detect and its dependencies, which are as follows:
* astropy
* matplotlib
* numpy
* scipy
* pynufft==2020.0.0
* pyyaml
To optionally implement CTI capabilities with the pure-Python arcticpy, navigate to the arcticpy directory (<https://github.com/roman-corgi/emccd_detect/tree/master/arcticpy_folder>), and there will be a file called setup.py in that directory. Use
pip install .
This will install arcticpy version 1.0. See (<https://github.com/jkeger/arcticpy/tree/row_wise/arcticpy>) for documentation. If
you have Python>3.9, the CTI functionality will not work if you are using the arcticpy installation that was included with this emccd_detect package, but everything else will work fine.
### Usage
For an example of how to use emccd\_detect, see example_script.py.
## Authors
* Bijan Nemati (<bijan.nemati@tellus1.com>)
* Sam Miller (<sam.miller@uah.edu>)
* Kevin Ludwick (<kevin.ludwick@uah.edu>)
Raw data
{
"_id": null,
"home_page": null,
"name": "emccd-detect",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": null,
"keywords": null,
"author": null,
"author_email": "Bijan Nemati <bijan.nemati@tellus1.com>, Sam Miller <sam.miller@uah.edu>, Kevin Ludwick <kevin.ludwick@uah.edu>",
"download_url": "https://files.pythonhosted.org/packages/29/10/d7cdf5263727d5cf3fd1bcfd0a67d5eaf615e2eeb854e0ff1787b25a8831/emccd_detect-2.5.0.tar.gz",
"platform": null,
"description": "# EMCCD Detect\n\nGiven an input fluxmap, emccd_detect will return a simulated EMCCD detector image. Website: (<https://github.com/roman-corgi/emccd_detect/tree/master/emccd_detect>)\n\n\n# Version\n\nThe latest version of emccd\\_detect is 2.5.0. Main differences from previous version, 2.4.0: \n--the ability to implement smear due to exposure of some rows while others are being read out. Credit for this smearing code: Peter Williams, Tellus1, 2024.\n--the ability to implement non-uniformity in pixel response via an input master flat. Assumed to be a FITS file.\n\n\n## Getting Started\n### Installing\n\nThis package requires Python version 3.6 or higher. If the user wants the ability to apply charge transfer inefficiency (CTI) to detector frames using the optional tool (older version of arcticpy which is pure Python) provided in emccd\\_detect, then the Python version should be >=3.6 and <=3.9. If the newer version of arcticpy (wrapper around C++ code) is installed, there is no upper limit restriction for Python version. For installation instructions and documentation for the newer arcticpy, see <https://github.com/jkeger/arctic>. emccd\\_detect works apart from arcticpy and does not require it.\n\nemccd\\_detect is available on PyPI.org, so the following command will install the module (without CTI capabilities):\n\n\tpip install emccd-detect\n\nTo install emccd\\_detect instead from this package download, after downloading, navigate to the emccd\\_detect directory where setup.py is located and use\n\n\tpip install .\n\nThis will install emccd\\_detect and its dependencies, which are as follows:\n\n* astropy\n* matplotlib\n* numpy\n* scipy\n* pynufft==2020.0.0\n* pyyaml\n\nTo optionally implement CTI capabilities with the pure-Python arcticpy, navigate to the arcticpy directory (<https://github.com/roman-corgi/emccd_detect/tree/master/arcticpy_folder>), and there will be a file called setup.py in that directory. Use\n\n\tpip install .\n\nThis will install arcticpy version 1.0. See (<https://github.com/jkeger/arcticpy/tree/row_wise/arcticpy>) for documentation. If\nyou have Python>3.9, the CTI functionality will not work if you are using the arcticpy installation that was included with this emccd_detect package, but everything else will work fine.\n\n\n### Usage\n\nFor an example of how to use emccd\\_detect, see example_script.py.\n\n\n## Authors\n\n* Bijan Nemati (<bijan.nemati@tellus1.com>)\n* Sam Miller (<sam.miller@uah.edu>)\n* Kevin Ludwick (<kevin.ludwick@uah.edu>)\n\n",
"bugtrack_url": null,
"license": null,
"summary": "EMCCD detector image simulation",
"version": "2.5.0",
"project_urls": null,
"split_keywords": [],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "9d2a6afeafe51c5d3985b138d95ad8ecd726334a4447bc721bcaee5195c5fada",
"md5": "905b3fdd71c4b89b24e2f237d58bfc34",
"sha256": "b827b27c3241554a51e50f519b4a7b5ea287ab50b3a05d23df9ad286e14e392e"
},
"downloads": -1,
"filename": "emccd_detect-2.5.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "905b3fdd71c4b89b24e2f237d58bfc34",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 19881,
"upload_time": "2025-09-11T23:48:18",
"upload_time_iso_8601": "2025-09-11T23:48:18.128568Z",
"url": "https://files.pythonhosted.org/packages/9d/2a/6afeafe51c5d3985b138d95ad8ecd726334a4447bc721bcaee5195c5fada/emccd_detect-2.5.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "2910d7cdf5263727d5cf3fd1bcfd0a67d5eaf615e2eeb854e0ff1787b25a8831",
"md5": "dd4c8fcd8c3574aeadbc5e521bc8cdd4",
"sha256": "41a34e89a05c11a28eee3ced09861ba041be8d491be228344b20df97aa481116"
},
"downloads": -1,
"filename": "emccd_detect-2.5.0.tar.gz",
"has_sig": false,
"md5_digest": "dd4c8fcd8c3574aeadbc5e521bc8cdd4",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 18889,
"upload_time": "2025-09-11T23:48:19",
"upload_time_iso_8601": "2025-09-11T23:48:19.296433Z",
"url": "https://files.pythonhosted.org/packages/29/10/d7cdf5263727d5cf3fd1bcfd0a67d5eaf615e2eeb854e0ff1787b25a8831/emccd_detect-2.5.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-09-11 23:48:19",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "emccd-detect"
}
