Metadata-Version: 2.1
Name: squishyplanet
Version: 0.2.0
Summary: A package for dealing with non-spherical exoplanets
Author-email: Ben Cassese <b.c.cassese@columbia.edu>
License: MIT
Project-URL: Homepage, https://github.com/ben-cassese/squishyplanet
Project-URL: Documentation, https://squishyplanet.readthedocs.io/en/latest/
Keywords: astronomy,exoplanets
Classifier: Programming Language :: Python
Classifier: Intended Audience :: Science/Research
Classifier: Topic :: Scientific/Engineering :: Astronomy
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: requests
Requires-Dist: jax <0.4.29
Requires-Dist: jaxlib <0.4.29
Requires-Dist: quadax
Requires-Dist: tqdm
Requires-Dist: black
Requires-Dist: astropy >5
Requires-Dist: matplotlib
Requires-Dist: sympy
Requires-Dist: ipykernel

# squishyplanet

[![status](https://joss.theoj.org/papers/2b62acea4e4d6c0de73309184861d1e9/status.svg)](https://joss.theoj.org/papers/2b62acea4e4d6c0de73309184861d1e9)
[![Documentation Status](https://readthedocs.org/projects/squishyplanet/badge/?version=latest)](https://squishyplanet.readthedocs.io/en/latest/?badge=latest)
![Build Status](https://github.com/ben-cassese/squishyplanet/actions/workflows/tests.yml/badge.svg)
[![Coverage Status](https://coveralls.io/repos/github/ben-cassese/squishyplanet/badge.svg?branch=main&service=github)](https://coveralls.io/github/ben-cassese/squishyplanet?branch=main)
![PyPI - Version](https://img.shields.io/pypi/v/squishyplanet)

A package for modeling non-spherical exoplanets.

![image](docs/_static/media/videos/_static/480p15/Banner_ManimCE_v0.17.3.gif)

## Documentation

The docs for ``squishyplanet`` are hosted on [Read the Docs](https://squishyplanet.readthedocs.io/en/latest/). See those for installation instructions, example usage, and API documentation.

## Installation

You can install ``squishyplanet`` from PyPI with pip:

```bash
python -m pip install squishyplanet
```

See the [installation instructions](https://squishyplanet.readthedocs.io/en/latest/installation.html) for more details.

## Attribution and License

 [![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
[hopefully joss badge]

``squishyplanet`` is made freely available under the MIT License. If you use this code in your research, please cite the accompanying JOSS paper. The citation information will be updated once the paper is submitted/accepted.

```
@article{
    squishyplanet,
    doi = {},
    url = {},
    year = 2024,
    month = {},
    publisher = {},
    volume = {},
    number = {},
    author = {},
    title = {squishyplanet: modeling transits of non-spherical exoplanets in JAX},
    journal = {}
}
```
