| Name | ocelot JSON |
| Version |
0.4.1
JSON |
| download |
| home_page | None |
| Summary | A toolbox for working with observations of star clusters. |
| upload_time | 2025-01-21 07:41:14 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.10 |
| license | MIT License Copyright (c) 2023 Emily Hunt Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| keywords |
astronomy
star cluster
threading
development
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
[](https://ocelot-docs.org)
[](https://pypi.org/project/ocelot/)
[](https://ocelot-docs.org)
# ocelot
A toolbox for working with observations of star clusters.
In the [long-running tradition](https://arxiv.org/abs/1903.12180) of astronomy software, `ocelot` is _not_ a good acronym for this project. It's the **O**pen-source star **C**lust**E**r mu**L**ti-purp**O**se **T**oolkit. (We hope the results you get from this package are better than this acronym)
## Current package status
⚠️ ocelot is currently in **alpha** and is in active development. **Expect breaking API changes** ⚠️
For the time being, `ocelot` is a collection of code that [emilyhunt](https://github.com/emilyhunt) wrote during her PhD, but the eventual goal will be to make a package usable by the entire star cluster community. If you'd like to see a feature added, then please consider opening an issue and proposing it!
## Installation
Install from PyPI with:
```
pip install ocelot
```
Currently, using `ocelot.simulate` also requires manually downloading data from [here](https://drive.google.com/file/d/1wMXymFHo-K5jdIGoJi5oGuHeXSa3JVmu/view?usp=sharing). Place it at a directory of your choosing, and set the environment variable `OCELOT_DATA` to this location.
If you're just working with a local dev copy of ocelot (i.e. you installed it via git clone), then you could put the data at the default location - /data in this folder.
## Development
We recommend using [uv](https://docs.astral.sh/uv/) to manage Python dependencies when developing a local copy of the project. Here's everything you need to do:
1. Clone the repo:
```
git clone https://github.com/emilyhunt/ocelot
```
2. Install [uv](https://docs.astral.sh/uv/getting-started/installation/), if you haven't already. (This won't mess with any of your other Python installations.)
3. Navigate to the new ocelot directory, and sync the project dependences _including dev and docs ones_ with:
```
uv sync --all-extras
```
After installing development dependencies, you can also locally view edits to the package's documentation. To view a local copy of the documentation, do `mkdocs serve`. You can do a test build with `mkdocs build`.
## Citation
There is currently no paper associated with `ocelot`. For now, please at least mention the package and add a footnote to your mention, linking to this repository - in LaTeX, that would be:
```
\footnote{\url{https://github.com/emilyhunt/ocelot}}
```
You can also cite [Hunt & Reffert 2021](https://ui.adsabs.harvard.edu/abs/2021A%26A...646A.104H/abstract), which was the paper for which development of this module began:
```
@ARTICLE{2021A&A...646A.104H,
author = {{Hunt}, Emily L. and {Reffert}, Sabine},
title = "{Improving the open cluster census. I. Comparison of clustering algorithms applied to Gaia DR2 data}",
journal = {\aap},
keywords = {methods: data analysis, open clusters and associations: general, astrometry, Astrophysics - Astrophysics of Galaxies, Astrophysics - Solar and Stellar Astrophysics},
year = 2021,
month = feb,
volume = {646},
eid = {A104},
pages = {A104},
doi = {10.1051/0004-6361/202039341},
archivePrefix = {arXiv},
eprint = {2012.04267},
primaryClass = {astro-ph.GA},
adsurl = {https://ui.adsabs.harvard.edu/abs/2021A&A...646A.104H},
adsnote = {Provided by the SAO/NASA Astrophysics Data System}
}
```
Raw data
{
"_id": null,
"home_page": null,
"name": "ocelot",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": "Emily Hunt <emily.hunt.physics@gmail.com>",
"keywords": "astronomy, star cluster, threading, development",
"author": null,
"author_email": "Emily Hunt <emily.hunt.physics@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/33/fd/81201273d0826c442c9423d411a4d7e3a95c915f3dc46b461e98470809e7/ocelot-0.4.1.tar.gz",
"platform": null,
"description": "[](https://ocelot-docs.org)\n[](https://pypi.org/project/ocelot/)\n[](https://ocelot-docs.org)\n\n# ocelot\n\nA toolbox for working with observations of star clusters. \n\nIn the [long-running tradition](https://arxiv.org/abs/1903.12180) of astronomy software, `ocelot` is _not_ a good acronym for this project. It's the **O**pen-source star **C**lust**E**r mu**L**ti-purp**O**se **T**oolkit. (We hope the results you get from this package are better than this acronym)\n\n## Current package status\n\n\u26a0\ufe0f ocelot is currently in **alpha** and is in active development. **Expect breaking API changes** \u26a0\ufe0f\n\nFor the time being, `ocelot` is a collection of code that [emilyhunt](https://github.com/emilyhunt) wrote during her PhD, but the eventual goal will be to make a package usable by the entire star cluster community. If you'd like to see a feature added, then please consider opening an issue and proposing it!\n\n## Installation\n\nInstall from PyPI with:\n\n```\npip install ocelot\n```\n\nCurrently, using `ocelot.simulate` also requires manually downloading data from [here](https://drive.google.com/file/d/1wMXymFHo-K5jdIGoJi5oGuHeXSa3JVmu/view?usp=sharing). Place it at a directory of your choosing, and set the environment variable `OCELOT_DATA` to this location. \n\nIf you're just working with a local dev copy of ocelot (i.e. you installed it via git clone), then you could put the data at the default location - /data in this folder.\n\n## Development\n\nWe recommend using [uv](https://docs.astral.sh/uv/) to manage Python dependencies when developing a local copy of the project. Here's everything you need to do:\n\n1. Clone the repo:\n\n```\ngit clone https://github.com/emilyhunt/ocelot\n```\n\n2. Install [uv](https://docs.astral.sh/uv/getting-started/installation/), if you haven't already. (This won't mess with any of your other Python installations.)\n\n3. Navigate to the new ocelot directory, and sync the project dependences _including dev and docs ones_ with:\n\n```\nuv sync --all-extras\n```\n\nAfter installing development dependencies, you can also locally view edits to the package's documentation. To view a local copy of the documentation, do `mkdocs serve`. You can do a test build with `mkdocs build`.\n\n\n## Citation\n\nThere is currently no paper associated with `ocelot`. For now, please at least mention the package and add a footnote to your mention, linking to this repository - in LaTeX, that would be:\n\n```\n\\footnote{\\url{https://github.com/emilyhunt/ocelot}}\n```\n\n\nYou can also cite [Hunt & Reffert 2021](https://ui.adsabs.harvard.edu/abs/2021A%26A...646A.104H/abstract), which was the paper for which development of this module began:\n\n```\n@ARTICLE{2021A&A...646A.104H,\n author = {{Hunt}, Emily L. and {Reffert}, Sabine},\n title = \"{Improving the open cluster census. I. Comparison of clustering algorithms applied to Gaia DR2 data}\",\n journal = {\\aap},\n keywords = {methods: data analysis, open clusters and associations: general, astrometry, Astrophysics - Astrophysics of Galaxies, Astrophysics - Solar and Stellar Astrophysics},\n year = 2021,\n month = feb,\n volume = {646},\n eid = {A104},\n pages = {A104},\n doi = {10.1051/0004-6361/202039341},\narchivePrefix = {arXiv},\n eprint = {2012.04267},\n primaryClass = {astro-ph.GA},\n adsurl = {https://ui.adsabs.harvard.edu/abs/2021A&A...646A.104H},\n adsnote = {Provided by the SAO/NASA Astrophysics Data System}\n}\n```\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2023 Emily Hunt Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ",
"summary": "A toolbox for working with observations of star clusters.",
"version": "0.4.1",
"project_urls": {
"Bug Reports": "https://github.com/emilyhunt/ocelot/issues",
"Homepage": "https://ocelot-docs.org",
"Source": "https://github.com/emilyhunt/ocelot"
},
"split_keywords": [
"astronomy",
" star cluster",
" threading",
" development"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "eea7d523dc88b7cb9c26e05573239fb8b2e00d15884bf375193423f0a1bec4e1",
"md5": "d26504e7973b86543b912772a8cba693",
"sha256": "c019664c77606e511ffeb59fc01dc8cb606789732e8f2ed34c66fa5f71cb21ce"
},
"downloads": -1,
"filename": "ocelot-0.4.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "d26504e7973b86543b912772a8cba693",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 123306,
"upload_time": "2025-01-21T07:41:12",
"upload_time_iso_8601": "2025-01-21T07:41:12.552174Z",
"url": "https://files.pythonhosted.org/packages/ee/a7/d523dc88b7cb9c26e05573239fb8b2e00d15884bf375193423f0a1bec4e1/ocelot-0.4.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "33fd81201273d0826c442c9423d411a4d7e3a95c915f3dc46b461e98470809e7",
"md5": "8c3e06306ad907a782ecbdc7537b4334",
"sha256": "c4d62c162c292f1a695200359b9d70bfb65843a1f309b8b1358a80dc96eb7d9f"
},
"downloads": -1,
"filename": "ocelot-0.4.1.tar.gz",
"has_sig": false,
"md5_digest": "8c3e06306ad907a782ecbdc7537b4334",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 116423,
"upload_time": "2025-01-21T07:41:14",
"upload_time_iso_8601": "2025-01-21T07:41:14.355904Z",
"url": "https://files.pythonhosted.org/packages/33/fd/81201273d0826c442c9423d411a4d7e3a95c915f3dc46b461e98470809e7/ocelot-0.4.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-01-21 07:41:14",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "emilyhunt",
"github_project": "ocelot",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "ocelot"
}
