| Name | acdc-hst JSON |
| Version |
1.1
JSON |
| download |
| home_page | None |
| Summary | Software to perform an optimized FUV (Far Ultraviolet) dark correction to HST COS data (Hubble Space Telescope Cosmic Origins Spectrograph). |
| upload_time | 2024-05-16 21:39:13 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.9 |
| license | BSD 3-Clause License Copyright (c) 2022, Jo Taylor All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. 3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
| keywords |
astronomy
hst
hubble
cos
ultraviolet
uv
dark
instrumentation
calibration
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Another COS Dark Correction (ACDC) ⚡
[](https://acdc-hst.readthedocs.io/en/latest/?badge=latest)
## Another dark correction?
COS spectroscopic science in the extreme UV regime is limited by detector
background noise. The COS pipeline,
[`CalCOS`](https://github.com/spacetelescope/calcos)
performs a basic background subtraction, but for low signal-to-noise ratio (SNR)
observations, a more nuanced approach is necessary to fully capitalize on COS's
FUV capabilities. In order to achieve the maximum scientific value of
the COS instrument, we have a designed a custom
characterization and correction of the COS FUV dark rate, `acdc`.
With `acdc`, we can:
* create and maintain databases needed to measure the dark rate as a function of time, HST position, PHA, solar activity, and more
* create COS/FUV superdarks
* use superdarks to perform custom dark corrections
* analyze the efficacy of custom dark-corrected COS data
For full usage instructions, refer to the
[documentation on ReadTheDocs](https://acdc-hst.readthedocs.io/).
## Installation
### Create a conda environment
If you do not already have Conda installed, you need to download and install
either Miniconda or Anaconda. Miniconda provides a bare minimum Conda
environment. Anaconda provides a full Conda root environment along with
many other tools, libraries, and utilities.
* get [Miniconda](https://docs.conda.io/en/latest/miniconda.html)
* get [Anaconda](https://www.anaconda.com/products/individual)
Create a conda enviornment to use `acdc`:
```
conda create -n <env_name> python=<version>
conda activate <env_name>
pip install .
```
where `<env_name>` is the name of the environment that will be created.
You need at least python version 3.9, so fill in `<version>` with whatever
version >=3.9 that you desire.
### Install the latest stable version
The easiest way to install `acdc` is to use `pip`:
```
pip install acdc-hst
```
> [!IMPORTANT]
>
> The [package name on PyPi](https://pypi.org/project/acdc-hst/) and the name of this repo,
> `acdc-hst`, are different than the _imported_ package name, `acdc`. That is,
> you import the package as `import acdc`.
### Install the development version
First clone this repo. Then `cd` into the cloned repository and execute:
```
pip install .
```
## Usage
For full usage instructions, refer to the
[documentation on ReadTheDocs](https://acdc-hst.readthedocs.io/).
## Building the docs locally
To build the documentation locally, for testing,
first clone this repository then navigate into the repo and follow these commands:
```
pip install ".[docs]"
cd docs/
make html
```
It will take a minute or two to build all the docs. Once finished, you can open the
docs in your default web browser with the following command:
```
open _build/html/index.html
```
From there you can click and navigate the webpage as if it were hosted online normally.
Raw data
{
"_id": null,
"home_page": null,
"name": "acdc-hst",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "astronomy, hst, hubble, cos, ultraviolet, uv, dark, instrumentation, calibration",
"author": null,
"author_email": "Jo Taylor <jotaylor@stsci.edu>",
"download_url": "https://files.pythonhosted.org/packages/9f/88/ce9c65e99f901b34462b0470bd0354cdab9c8c0125334d2109450a12fdb4/acdc_hst-1.1.tar.gz",
"platform": null,
"description": "# Another COS Dark Correction (ACDC) \u26a1\n\n[](https://acdc-hst.readthedocs.io/en/latest/?badge=latest)\n\n## Another dark correction?\nCOS spectroscopic science in the extreme UV regime is limited by detector \nbackground noise. The COS pipeline, \n[`CalCOS`](https://github.com/spacetelescope/calcos) \nperforms a basic background subtraction, but for low signal-to-noise ratio (SNR)\nobservations, a more nuanced approach is necessary to fully capitalize on COS's\nFUV capabilities. In order to achieve the maximum scientific value of\nthe COS instrument, we have a designed a custom\ncharacterization and correction of the COS FUV dark rate, `acdc`.\n\nWith `acdc`, we can: \n* create and maintain databases needed to measure the dark rate as a function of time, HST position, PHA, solar activity, and more\n* create COS/FUV superdarks\n* use superdarks to perform custom dark corrections\n* analyze the efficacy of custom dark-corrected COS data\n\nFor full usage instructions, refer to the \n[documentation on ReadTheDocs](https://acdc-hst.readthedocs.io/). \n\n## Installation\n\n### Create a conda environment\nIf you do not already have Conda installed, you need to download and install\neither Miniconda or Anaconda. Miniconda provides a bare minimum Conda\nenvironment. Anaconda provides a full Conda root environment along with\nmany other tools, libraries, and utilities.\n* get [Miniconda](https://docs.conda.io/en/latest/miniconda.html)\n* get [Anaconda](https://www.anaconda.com/products/individual)\n\nCreate a conda enviornment to use `acdc`:\n\n```\nconda create -n <env_name> python=<version>\nconda activate <env_name>\npip install .\n```\n\nwhere `<env_name>` is the name of the environment that will be created.\nYou need at least python version 3.9, so fill in `<version>` with whatever\nversion >=3.9 that you desire.\n\n### Install the latest stable version\nThe easiest way to install `acdc` is to use `pip`:\n\n```\npip install acdc-hst\n```\n\n> [!IMPORTANT]\n> \n> The [package name on PyPi](https://pypi.org/project/acdc-hst/) and the name of this repo,\n> `acdc-hst`, are different than the _imported_ package name, `acdc`. That is,\n> you import the package as `import acdc`.\n\n### Install the development version\n\nFirst clone this repo. Then `cd` into the cloned repository and execute:\n\n```\npip install .\n```\n\n## Usage\n\nFor full usage instructions, refer to the \n[documentation on ReadTheDocs](https://acdc-hst.readthedocs.io/). \n\n## Building the docs locally\nTo build the documentation locally, for testing, \nfirst clone this repository then navigate into the repo and follow these commands:\n\n```\npip install \".[docs]\"\ncd docs/\nmake html\n```\n\nIt will take a minute or two to build all the docs. Once finished, you can open the \ndocs in your default web browser with the following command:\n\n```\nopen _build/html/index.html \n```\n\nFrom there you can click and navigate the webpage as if it were hosted online normally.\n",
"bugtrack_url": null,
"license": "BSD 3-Clause License Copyright (c) 2022, Jo Taylor All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. 3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS \"AS IS\" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. ",
"summary": "Software to perform an optimized FUV (Far Ultraviolet) dark correction to HST COS data (Hubble Space Telescope Cosmic Origins Spectrograph).",
"version": "1.1",
"project_urls": {
"Documentation": "https://github.com/jotaylor/cos_dark",
"Homepage": "https://github.com/jotaylor/cos_dark",
"Source": "https://github.com/jotaylor/cos_dark",
"Tracker": "https://github.com/jotaylor/cos_dark/issues"
},
"split_keywords": [
"astronomy",
" hst",
" hubble",
" cos",
" ultraviolet",
" uv",
" dark",
" instrumentation",
" calibration"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "558ca5140284ddde4feabe1bf38a4fbad2a429e798cd66676dbccff2abe44667",
"md5": "572d5f634a8c1d00137328ffbeb41cd1",
"sha256": "46fb108b97966bea4dff9ee00a7a039a8eea53f9f0582e516de9b72e6baf69d7"
},
"downloads": -1,
"filename": "acdc_hst-1.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "572d5f634a8c1d00137328ffbeb41cd1",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 826050,
"upload_time": "2024-05-16T21:39:11",
"upload_time_iso_8601": "2024-05-16T21:39:11.322562Z",
"url": "https://files.pythonhosted.org/packages/55/8c/a5140284ddde4feabe1bf38a4fbad2a429e798cd66676dbccff2abe44667/acdc_hst-1.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "9f88ce9c65e99f901b34462b0470bd0354cdab9c8c0125334d2109450a12fdb4",
"md5": "57b54777e86132ccc0abef6d4d061540",
"sha256": "5c92039b38dfa7a6c22930839460167bdd6eb3682dd4008c9acde1fcbf921b09"
},
"downloads": -1,
"filename": "acdc_hst-1.1.tar.gz",
"has_sig": false,
"md5_digest": "57b54777e86132ccc0abef6d4d061540",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 805902,
"upload_time": "2024-05-16T21:39:13",
"upload_time_iso_8601": "2024-05-16T21:39:13.434551Z",
"url": "https://files.pythonhosted.org/packages/9f/88/ce9c65e99f901b34462b0470bd0354cdab9c8c0125334d2109450a12fdb4/acdc_hst-1.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-05-16 21:39:13",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "jotaylor",
"github_project": "cos_dark",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "acdc-hst"
}
