| Name | ExoEcho JSON |
| Version |
0.1.6
JSON |
| download |
| home_page | None |
| Summary | To estimate the noise of various telescopes conducting exoplanet-related observations. |
| upload_time | 2024-08-21 16:22:05 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.11 |
| license | Copyright (c) 2024, Ben Coull-Neveu Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies. THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. |
| keywords |
ariel
jwst
noise
telescope noise
noise estimate
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# ExoEcho
Welcome to ExoEcho! This repository contains the ExoEcho package, a tool for estimating signal and noise of exoplanet observations.
## Features
- Provides a tool to create Telescope objects.
- Estimates signal & noise of observations conducted by customizable Telescopes!
- Provides a variety of commonly-used telescope systems for exoplanetary observations.
- Various tools specifically made for the upcoming Ariel mission, including all the instruments at key spectral resolutions. In particular, it provides useful plotting functions for the Ariel telescope.
## Installation
To install ExoEcho, simply run the following command:
```bash
pip install exoecho
```
<!-- ## Usage
Here's a quick example to get you started:
```python
import exoecho
# Getting Billy Edwards' target list
# Creating telescope object
jwst_nirspec = Telescope(name="JWST NIRSpec", diameter=6.5, wavelength_range=(0.6, 5.3), resolution=100, throughput=0.36)
# Preprocess the data
preprocessed_data = exoecho.preprocess(data)
# Detect echoes
echoes = exoecho.detect_echoes(preprocessed_data)
# Analyze and visualize the results
exoecho.analyze(echoes)
exoecho.visualize(echoes)
``` -->
## Target List Requirements
The target list that you want to use has to meet certain citeria. First of all, it must be passed as a pandas.DataFrame to ensure consistency with the rest of the package. Most importantly, you must run it through the cleanTargets.py script, which will separate out some given values and their respective uncertainties, the latter(s) of which can be found under the column names f"{column} upper unc" and f"{column} lower unc". **Note that for upper or lower limit values, the given value will be kept but the "<" or ">" symbol will be remove.** Also, you can add which column should be ignored by the cleaning process (such as notes / remarks, target names, references, etc).
Now for the most important prerequisite for the target lists: column names. I will list of the required target names (which are case sensitive). Please take note of the units, when applicable.
- Star Temperature [K]
- Star Radius [Rs]
- Star Distance [pc]
- Planet Name
- Planet Radius [Rjup]
- Planet Mass [Mjup]
- Planet Semi-major Axis [au]
- Planet Period [days]
- Transit Duration [hrs]
<!-- *Transit Duration [hrs]* is a special case, since it can also be estimated using pylightcurve, but that requires more information. -->
The following are optional column names. If they are not provided, the respective default values will be put instead (shown beside the name, separated by an arrow). Note that *Planet Albedo* is the planet's **bond** albedo. Default values for *Planet Albedo*, *Heat Redistribution Factor*, and *Mean Molecular Weight* are given by Edwards et al. [[1](#edwards)]. The default *Planet Geometric Albedo* is given by Heng et al. [[2](#heng)]
- Planet Albedo -> 0.2
- Heat Redistribution Factor -> 0.8
- Mean Molecular Weight -> 2.3
- Planet Geometric Albedo -> 0.25
- Eclipse Duration [hrs] -> made equal to transit duration [hrs]
## License
ExoEcho is licensed under the MIT License. See [LICENSE](LICENSE) for more information.
## Contact
If you have any questions or suggestions, feel free to reach out to us at benjamin.coull-neveu@mail.mcgill.ca.
## References
[1] <a name="edwards">Edwards et al., “An Updated Study of Potential Targets for Ariel.”</a>
[2] <a name="heng">Heng, Morris, and Kitzmann, “Closed-Formed Ab Initio Solutions of Geometric Albedos and Reflected Light Phase Curves of Exoplanets.”</a>
Raw data
{
"_id": null,
"home_page": null,
"name": "ExoEcho",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.11",
"maintainer_email": null,
"keywords": "Ariel, JWST, Noise, Telescope Noise, Noise Estimate",
"author": null,
"author_email": "Ben Coull-Neveu <benjamin.coull-neveu@mail.mcgill.ca>",
"download_url": "https://files.pythonhosted.org/packages/e1/38/886c911d99b2f65c5e8b29df7388efa44f4d2044e8e0eab84d6b893f4670/exoecho-0.1.6.tar.gz",
"platform": null,
"description": "# ExoEcho\r\n\r\nWelcome to ExoEcho! This repository contains the ExoEcho package, a tool for estimating signal and noise of exoplanet observations. \r\n\r\n## Features\r\n\r\n- Provides a tool to create Telescope objects.\r\n- Estimates signal & noise of observations conducted by customizable Telescopes! \r\n- Provides a variety of commonly-used telescope systems for exoplanetary observations.\r\n- Various tools specifically made for the upcoming Ariel mission, including all the instruments at key spectral resolutions. In particular, it provides useful plotting functions for the Ariel telescope.\r\n\r\n## Installation\r\n\r\nTo install ExoEcho, simply run the following command:\r\n\r\n```bash\r\npip install exoecho\r\n```\r\n\r\n<!-- ## Usage\r\n\r\nHere's a quick example to get you started:\r\n\r\n```python\r\nimport exoecho\r\n\r\n# Getting Billy Edwards' target list\r\n\r\n\r\n# Creating telescope object\r\njwst_nirspec = Telescope(name=\"JWST NIRSpec\", diameter=6.5, wavelength_range=(0.6, 5.3), resolution=100, throughput=0.36)\r\n\r\n# Preprocess the data\r\npreprocessed_data = exoecho.preprocess(data)\r\n\r\n# Detect echoes\r\nechoes = exoecho.detect_echoes(preprocessed_data)\r\n\r\n# Analyze and visualize the results\r\nexoecho.analyze(echoes)\r\nexoecho.visualize(echoes)\r\n``` -->\r\n\r\n## Target List Requirements\r\nThe target list that you want to use has to meet certain citeria. First of all, it must be passed as a pandas.DataFrame to ensure consistency with the rest of the package. Most importantly, you must run it through the cleanTargets.py script, which will separate out some given values and their respective uncertainties, the latter(s) of which can be found under the column names f\"{column} upper unc\" and f\"{column} lower unc\". **Note that for upper or lower limit values, the given value will be kept but the \"<\" or \">\" symbol will be remove.** Also, you can add which column should be ignored by the cleaning process (such as notes / remarks, target names, references, etc). \r\n\r\nNow for the most important prerequisite for the target lists: column names. I will list of the required target names (which are case sensitive). Please take note of the units, when applicable.\r\n\r\n- Star Temperature [K]\r\n- Star Radius [Rs]\r\n- Star Distance [pc]\r\n- Planet Name\r\n- Planet Radius [Rjup]\r\n- Planet Mass [Mjup]\r\n- Planet Semi-major Axis [au]\r\n- Planet Period [days]\r\n- Transit Duration [hrs]\r\n\r\n<!-- *Transit Duration [hrs]* is a special case, since it can also be estimated using pylightcurve, but that requires more information. -->\r\n\r\nThe following are optional column names. If they are not provided, the respective default values will be put instead (shown beside the name, separated by an arrow). Note that *Planet Albedo* is the planet's **bond** albedo. Default values for *Planet Albedo*, *Heat Redistribution Factor*, and *Mean Molecular Weight* are given by Edwards et al. [[1](#edwards)]. The default *Planet Geometric Albedo* is given by Heng et al. [[2](#heng)]\r\n\r\n- Planet Albedo -> 0.2\r\n- Heat Redistribution Factor -> 0.8\r\n- Mean Molecular Weight -> 2.3\r\n- Planet Geometric Albedo -> 0.25\r\n- Eclipse Duration [hrs] -> made equal to transit duration [hrs]\r\n\r\n## License\r\n\r\nExoEcho is licensed under the MIT License. See [LICENSE](LICENSE) for more information.\r\n\r\n## Contact\r\n\r\nIf you have any questions or suggestions, feel free to reach out to us at benjamin.coull-neveu@mail.mcgill.ca.\r\n\r\n\r\n## References\r\n[1] <a name=\"edwards\">Edwards et al., \u201cAn Updated Study of Potential Targets for Ariel.\u201d</a>\r\n[2] <a name=\"heng\">Heng, Morris, and Kitzmann, \u201cClosed-Formed Ab Initio Solutions of Geometric Albedos and Reflected Light Phase Curves of Exoplanets.\u201d</a>\r\n",
"bugtrack_url": null,
"license": "Copyright (c) 2024, Ben Coull-Neveu Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies. THE SOFTWARE IS PROVIDED \"AS IS\" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ",
"summary": "To estimate the noise of various telescopes conducting exoplanet-related observations.",
"version": "0.1.6",
"project_urls": null,
"split_keywords": [
"ariel",
" jwst",
" noise",
" telescope noise",
" noise estimate"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "e073540338799bc232ea8f0ea4322210a9f7a0e77d5a1da08f9e5523a33850d4",
"md5": "739bb44b155ac3f1b410be8ce612cf3f",
"sha256": "851b15d9e1cd88208587ec035e4e1bc58661af6fba387c14fe140e64856d2be7"
},
"downloads": -1,
"filename": "ExoEcho-0.1.6-py3-none-any.whl",
"has_sig": false,
"md5_digest": "739bb44b155ac3f1b410be8ce612cf3f",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.11",
"size": 81919006,
"upload_time": "2024-08-21T16:21:57",
"upload_time_iso_8601": "2024-08-21T16:21:57.855850Z",
"url": "https://files.pythonhosted.org/packages/e0/73/540338799bc232ea8f0ea4322210a9f7a0e77d5a1da08f9e5523a33850d4/ExoEcho-0.1.6-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "e138886c911d99b2f65c5e8b29df7388efa44f4d2044e8e0eab84d6b893f4670",
"md5": "819ab75a27a793608a31f37e44ab2e00",
"sha256": "4efd89f9eb3241bc282a052ffa3f5ea5c7864f49c3e706817cb0630244fe57c5"
},
"downloads": -1,
"filename": "exoecho-0.1.6.tar.gz",
"has_sig": false,
"md5_digest": "819ab75a27a793608a31f37e44ab2e00",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.11",
"size": 81250147,
"upload_time": "2024-08-21T16:22:05",
"upload_time_iso_8601": "2024-08-21T16:22:05.901873Z",
"url": "https://files.pythonhosted.org/packages/e1/38/886c911d99b2f65c5e8b29df7388efa44f4d2044e8e0eab84d6b893f4670/exoecho-0.1.6.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-21 16:22:05",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "exoecho"
}
