# 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.3.0.
## 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 provided in emccd\_detect, then the Python version should be >=3.6 and <=3.9.
To install emccd\_detect, 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, 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, which is an older version of arcticpy which runs purely on Python (<https://github.com/jkeger/arcticpy/tree/row_wise/arcticpy>). If
you have Python>=3.10, 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": "https://github.jpl.nasa.gov/WFIRST-CGI/emccd_detect",
"name": "emccd-detect",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": null,
"keywords": null,
"author": "Bijan Nemati, Sam Miller, Kevin Ludwick",
"author_email": "bijan.nemati@tellus1.com, sam.miller@uah.edu, kevin.ludwick@uah.edu",
"download_url": "https://files.pythonhosted.org/packages/ac/23/824c757a04b99d753cc79d7c80a1a3b5f9895aa34272c66117a2741117d4/emccd_detect-2.3.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.3.0.\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 provided in emccd\\_detect, then the Python version should be >=3.6 and <=3.9.\n\nTo install emccd\\_detect, 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, 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, which is an older version of arcticpy which runs purely on Python (<https://github.com/jkeger/arcticpy/tree/row_wise/arcticpy>). If\nyou have Python>=3.10, 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.3.0",
"project_urls": {
"Homepage": "https://github.jpl.nasa.gov/WFIRST-CGI/emccd_detect"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "1870bb861a7e2e0de15e6b19a915c3c69f998558a5aa74a5c730a1f1c036aa53",
"md5": "014437874391fc561173f661620ca6be",
"sha256": "3fe3803650d4bf92955b494dbb7e3f53dccfeb8594dc4e5b2eb0e789067e76af"
},
"downloads": -1,
"filename": "emccd_detect-2.3.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "014437874391fc561173f661620ca6be",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 17654,
"upload_time": "2024-09-04T20:52:41",
"upload_time_iso_8601": "2024-09-04T20:52:41.971638Z",
"url": "https://files.pythonhosted.org/packages/18/70/bb861a7e2e0de15e6b19a915c3c69f998558a5aa74a5c730a1f1c036aa53/emccd_detect-2.3.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "ac23824c757a04b99d753cc79d7c80a1a3b5f9895aa34272c66117a2741117d4",
"md5": "ba560557d062e66bebb2a3ce42251ceb",
"sha256": "bd637c3781be9e64eb7d5e791e34245db285ecda16367ceee60ec088beba3e2b"
},
"downloads": -1,
"filename": "emccd_detect-2.3.0.tar.gz",
"has_sig": false,
"md5_digest": "ba560557d062e66bebb2a3ce42251ceb",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 15776,
"upload_time": "2024-09-04T20:52:43",
"upload_time_iso_8601": "2024-09-04T20:52:43.029581Z",
"url": "https://files.pythonhosted.org/packages/ac/23/824c757a04b99d753cc79d7c80a1a3b5f9895aa34272c66117a2741117d4/emccd_detect-2.3.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-09-04 20:52:43",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "emccd-detect"
}
JSON