Metadata-Version: 2.1
Name: kepler.py
Version: 0.0.5
Summary: Fast and stable Kepler solver
Home-page: https://github.com/dfm/kepler.py
Author: Daniel Foreman-Mackey
Author-email: foreman.mackey@gmail.com
Maintainer: Daniel Foreman-Mackey
Maintainer-email: foreman.mackey@gmail.com
License: MIT
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Description-Content-Type: text/markdown
Requires-Dist: numpy (>=1.13.0)
Requires-Dist: pybind11 (>=2.5.0)
Requires-Dist: setuptools (>=40.6.0)
Requires-Dist: setuptools-scm
Provides-Extra: release
Requires-Dist: twine ; extra == 'release'
Requires-Dist: wheel ; extra == 'release'
Requires-Dist: pep517 ; extra == 'release'
Provides-Extra: test
Requires-Dist: pytest ; extra == 'test'

Fast and stable solver for Kepler's equation extracted from [exoplanet](https://docs.exoplanet.codes).

## Installation

The best way to install is using pip:

```bash
python -m pip install kepler.py
```

## Usage

This package exposes two functions:

* `kepler`: Solves Kepler's equation and returns the cosine and sine of the true anomaly:

```python
import kepler
eccentric_anomaly, cos_true_anomaly, sin_true_anomaly = kepler.kepler(mean_anomaly, eccentricity)
```

* `solve`: A lower-level interface that is used by `kepler` to actually do the solving (*Note that this will return garbage for eccentricities out of the range zero to one*):

```python
import kepler
eccentric_anomaly = kepler.solve(mean_anomaly, eccentricity)
```


