| Name | gaia-cmd-plotter JSON |
| Version |
0.1.5
JSON |
| download |
| home_page | https://github.com/coryzh/gaia_cmd_plotter |
| Summary | A Python package that provides a matplotlib.pyplot.Axes object that displays a Gaia CMD background. |
| upload_time | 2024-02-24 13:49:14 |
| maintainer | |
| docs_url | None |
| author | Yue Zhao |
| requires_python | >=3.8 |
| license | |
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# gaia-cmd-plotter
`gaia_cmd_plotter` is a Python package for creating customized Matplotlib axes that display a Gaia Color-Magnitude
Diagram (CMD) background. This package is useful for visualising astronomical data within the context of a Gaia CMD.
## Installation
You can install gaia_cmd_plotter using `pip`:
```bash
pip install gaia-cmd-plotter
```
## Usage
To use the package, first import the `GaiaCMDAxis` class from the `gaia_cmd_plotter.gaia_cmd_plotter` module.
```python
from gaia_cmd_plotter.gaia_cmd_axis import GaiaCMDAxis
```
Next, create a new `GaiaCMDAxis` object and add it to a Matplotlib figure.
```python
import matplotlib.pyplot as plt
fig = plt.figure(figsize=(8, 8))
ax = GaiaCMDAxis(fig)
```
You can then use the `GaiaCMDAxis` object like any other Matplotlib axis. For example, you can plot data on top of
the Gaia CMD background,
```python
bp_rp = 3.5
g_abs = 5.0
ax.plot(bp_rp, g_abs, "ko", ms=10, mec="k")
```
## Acknowledgements
This package has made use of data from the European Space Agency (ESA) [Gaia mission](https://www.cosmos.esa.int/gaia),
processed by the [Gaia Data Processing and Analysis Consortium](https://www.cosmos.esa.int/web/gaia/dpac/consortium).
The CMD background data was obtained from the Gaia data release 3 (DR3; Gaia Collaboration et al. 2016, 2023). The bulk
of points in the CMD background are retrieved from the Gaia DR3 catalog, using the query in Gaia Collaboration 2018.
## References
1. [Gaia Collaboration, 2016, A&A, 595, A1](https://ui.adsabs.harvard.edu/abs/2016A%26A...595A...1G/abstract)
2. [Gaia Collaboration, 2018, A&A, 616, A10](https://ui.adsabs.harvard.edu/abs/2018A%26A...616A...1G/abstract)
3. [Gaia Collaboration, 2023, A&A, 674, A38](https://ui.adsabs.harvard.edu/abs/2023A%26A...674A...1G/abstract)
Raw data
{
"_id": null,
"home_page": "https://github.com/coryzh/gaia_cmd_plotter",
"name": "gaia-cmd-plotter",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "",
"keywords": "",
"author": "Yue Zhao",
"author_email": "Yue.Zhao@soton.ac.uk",
"download_url": "https://files.pythonhosted.org/packages/79/83/c7b18a4c0bf1839ceff2528bbedf043a06ee2a40532cfad41655bda9dd17/gaia_cmd_plotter-0.1.5.tar.gz",
"platform": null,
"description": "# gaia-cmd-plotter\n\n`gaia_cmd_plotter` is a Python package for creating customized Matplotlib axes that display a Gaia Color-Magnitude\nDiagram (CMD) background. This package is useful for visualising astronomical data within the context of a Gaia CMD.\n\n## Installation\n\nYou can install gaia_cmd_plotter using `pip`:\n\n```bash\npip install gaia-cmd-plotter\n```\n\n## Usage\n\nTo use the package, first import the `GaiaCMDAxis` class from the `gaia_cmd_plotter.gaia_cmd_plotter` module.\n```python\nfrom gaia_cmd_plotter.gaia_cmd_axis import GaiaCMDAxis\n```\n\nNext, create a new `GaiaCMDAxis` object and add it to a Matplotlib figure.\n```python\nimport matplotlib.pyplot as plt\nfig = plt.figure(figsize=(8, 8))\nax = GaiaCMDAxis(fig)\n```\n\nYou can then use the `GaiaCMDAxis` object like any other Matplotlib axis. For example, you can plot data on top of \nthe Gaia CMD background, \n```python\nbp_rp = 3.5\ng_abs = 5.0\nax.plot(bp_rp, g_abs, \"ko\", ms=10, mec=\"k\")\n```\n\n## Acknowledgements\nThis package has made use of data from the European Space Agency (ESA) [Gaia mission](https://www.cosmos.esa.int/gaia), \nprocessed by the [Gaia Data Processing and Analysis Consortium](https://www.cosmos.esa.int/web/gaia/dpac/consortium). \nThe CMD background data was obtained from the Gaia data release 3 (DR3; Gaia Collaboration et al. 2016, 2023). The bulk \nof points in the CMD background are retrieved from the Gaia DR3 catalog, using the query in Gaia Collaboration 2018.\n\n\n## References\n1. [Gaia Collaboration, 2016, A&A, 595, A1](https://ui.adsabs.harvard.edu/abs/2016A%26A...595A...1G/abstract)\n2. [Gaia Collaboration, 2018, A&A, 616, A10](https://ui.adsabs.harvard.edu/abs/2018A%26A...616A...1G/abstract)\n3. [Gaia Collaboration, 2023, A&A, 674, A38](https://ui.adsabs.harvard.edu/abs/2023A%26A...674A...1G/abstract)\n",
"bugtrack_url": null,
"license": "",
"summary": "A Python package that provides a matplotlib.pyplot.Axes object that displays a Gaia CMD background.",
"version": "0.1.5",
"project_urls": {
"Homepage": "https://github.com/coryzh/gaia_cmd_plotter",
"Source Code": "https://github.com/coryzh/gaia_cmd_plotter"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "7983c7b18a4c0bf1839ceff2528bbedf043a06ee2a40532cfad41655bda9dd17",
"md5": "169f02b37a69db1063bc59e143f421c9",
"sha256": "80c0cad39976c41c5c7954f1c1a46ee22f679697a0bbbb9b30093bb79cbbd1e7"
},
"downloads": -1,
"filename": "gaia_cmd_plotter-0.1.5.tar.gz",
"has_sig": false,
"md5_digest": "169f02b37a69db1063bc59e143f421c9",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 154555,
"upload_time": "2024-02-24T13:49:14",
"upload_time_iso_8601": "2024-02-24T13:49:14.054114Z",
"url": "https://files.pythonhosted.org/packages/79/83/c7b18a4c0bf1839ceff2528bbedf043a06ee2a40532cfad41655bda9dd17/gaia_cmd_plotter-0.1.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-02-24 13:49:14",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "coryzh",
"github_project": "gaia_cmd_plotter",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "gaia-cmd-plotter"
}
