Metadata-Version: 2.1
Name: ocelot
Version: 0.3.1a0
Summary: A toolbox for working with observations of star clusters.
Author-email: Emily Hunt <emily.hunt.physics@gmail.com>
Maintainer-email: Emily Hunt <emily.hunt.physics@gmail.com>
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.
        
Project-URL: Homepage, https://ocelot-docs.org
Project-URL: Bug Reports, https://github.com/emilyhunt/ocelot/issues
Project-URL: Source, https://github.com/emilyhunt/ocelot
Keywords: astronomy,star cluster,threading,development
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3 :: Only
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: numpy <3.0,>1.21.0
Requires-Dist: matplotlib <4.0,>3.4.0
Requires-Dist: scikit-learn <2.0,>0.24.0
Requires-Dist: scipy <2.0,>1.0.0
Requires-Dist: pandas <3.0,>1.0.0
Requires-Dist: astropy <7.0,>4.0.0
Requires-Dist: healpy <2.0,>1.13.0
Provides-Extra: dev
Requires-Dist: check-manifest ; extra == 'dev'
Requires-Dist: pytest ; extra == 'dev'
Requires-Dist: mkdocs-material[imaging] ; extra == 'dev'
Requires-Dist: mkdocstrings[python] >=0.18 ; extra == 'dev'
Provides-Extra: docs
Requires-Dist: mkdocs-material[imaging] ; extra == 'docs'
Requires-Dist: mkdocstrings[python] >=0.18 ; extra == 'docs'
Provides-Extra: test
Requires-Dist: pytest ; extra == 'test'

[![docs](https://img.shields.io/badge/docs-latest-blue.svg)](https://ocelot-docs.org)
[![Build Docs](https://github.com/emilyhunt/ocelot/actions/workflows/build-docs.yml/badge.svg)](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
```

## Development

If you'd like to contribute to the package, we recommend setting up a new virtual environment of your choice. Then, you can install the latest commit on the main branch in edit mode (`-e`) with all development dependencies (`[dev]`) with:

```
pip install -e git+https://github.com/emilyhunt/ocelot[dev]
```

After installing development dependencies, you can also make and 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`.
