Metadata-Version: 2.5
Name: astrocats
Version: 0.5.0
Summary: Package for downloading, analyzing, and constructing open astronomy catalogs.
Project-URL: Homepage, https://github.com/astrocatalogs/astrocats
Project-URL: Repository, https://github.com/astrocatalogs/astrocats
Author-email: James Guillochon & Luke Kelley <guillochon@gmail.com>
License-Expression: MIT
License-File: LICENSE
Keywords: astronomy
Classifier: Development Status :: 3 - Alpha
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Requires-Python: >=3.11
Requires-Dist: astropy>=7.1
Requires-Dist: beautifulsoup4>=4.13
Requires-Dist: bokeh>=3.7
Requires-Dist: gitpython>=3.1.45
Requires-Dist: inflect>=7.5
Requires-Dist: matplotlib>=3.10
Requires-Dist: numpy>=2.3
Requires-Dist: palettable>=3.3
Requires-Dist: psutil>=7.0
Requires-Dist: requests>=2.32
Requires-Dist: seaborn>=0.13
Requires-Dist: tqdm>=4.67
Provides-Extra: ads
Requires-Dist: ads>=0.12; extra == 'ads'
Description-Content-Type: text/markdown

# Astrocats: Open Astronomy Catalogs #

[![CI](https://github.com/astrocatalogs/astrocats/actions/workflows/ci.yml/badge.svg)](https://github.com/astrocatalogs/astrocats/actions/workflows/ci.yml)
[![Python Version](https://img.shields.io/badge/python-3.11%2B-blue.svg)](https://www.python.org)
[![arXiv](https://img.shields.io/badge/arXiv-1605.01054-green.svg?style=flat)](http://arxiv.org/abs/1605.01054)

The Astrocats package enables astronomers to construct their own curated catalogs of astronomical data with the intention of producing shareable catalogs of that data in human-readable formats. Astrocats is used by several existing open astronomy catalogs, including:

* [The Open Supernova Catalog](https://sne.space) [[GitHub repo](https://github.com/astrocatalogs/supernovae)]
* [The Open TDE Catalog](https://tde.space) [[GitHub repo](https://github.com/astrocatalogs/tidaldisruptions)]
* [The Open Nova Catalog](https://opennova.space) [[GitHub repo](https://github.com/astrocatalogs/novae)]
* [The Open Black Hole Catalog](https://holes.space) [[GitHub repo](https://github.com/astrocatalogs/blackholes)]

The process for creating one's own open astronomy catalog involves checking out this package and designing a "module" for it that is specific to that catalog's needs, a [Wiki is available](https://github.com/astrocatalogs/astrocats/wiki) with instructions for doing so. At the moment the most developed module is the Open Supernova Catalog module; to set up astrocats with the supernovae module, one needs to check out two repositories:

```shell
git clone git@github.com:astrocatalogs/astrocats.git
cd astrocats
git clone git@github.com:astrocatalogs/supernovae.git
```

## Install

This project requires [Python 3.11](https://www.python.org/downloads/) or later and uses [uv](https://docs.astral.sh/uv/) for package management.

```shell
uv python pin 3.11
uv sync
uv run astrocats setup
```

Run the test suite with:

```shell
uv run pytest
```
