Metadata-Version: 2.4
Name: whereistheplanet
Version: 1.1.0
Summary: predict exoplanet locations
License-Expression: BSD-3-Clause
Keywords: Exoplanets,Astronomy,Orbits,Astrometry
Classifier: Intended Audience :: Science/Research
Classifier: Topic :: Scientific/Engineering :: Astronomy
Classifier: Programming Language :: Python :: 3
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: numpy
Requires-Dist: astropy
Requires-Dist: h5py
Requires-Dist: orbitize
Dynamic: license-file

# whereistheplanet?
Prediciting the position of exoplanets. Web version is available at https://www.whereistheplanet.com/. Credit: Jason Wang, Matas Kulikauskas, and Sarah Blunt. 
 
![Teseting Badge](https://github.com/semaphoreP/whereistheplanet/actions/workflows/ci-tests.yml/badge.svg) [![ASCL Reference](https://img.shields.io/badge/ascl-2101.003-blue.svg?colorB=262255)](https://ascl.net/2101.003)

## Install

`whereistheplanet` is easily installed through PyPI:

```
pip install whereistheplanet
```

### Developer Install

Requires `orbitize!` (https://github.com/sblunt/orbitize/) and `git-lfs` to pull the posteriors. After you clone the repositroy and use `git lfs pull` to pull the posteriors, install using 
```
pip install -e .
``` 
This creates a script `whereistheplanet` that you can call from anywhere in the terminal. 

If you have issues running whereistheplanet on your machine, you can check out the [querytheplanet](https://github.com/vandalt/querytheplanet) package. Howevert, please do not run large amounts (100+) queries in a short span of time, to avoid overloading the webserver. To avoid large number of queries, you should probably be computing the orbit yourself.

## Tutorial

Open a terminal window and run
```
whereistheplanet hr8799b
```

If you want the planet location at a particular date.
```
whereistheplanet hr8799b --time 2019-01-01
```

To see all of the planets currently supported:
```
whereistheplanet --list
```

## Catalog maintenance

Public target names, references and companion layouts live in
`whereistheplanet/catalog.py`; the web menu uses the same catalog.
The catalog includes 99 targets. See [CHANGELOG.md](CHANGELOG.md) for release changes.

## Attribution

If you used this for your research, please cite the [ASCL entry](https://ascl.net/2101.003) of it:

    Wang, J. J., Kulikauskas, M., Blunt, S. 2021, Astrophysics Source Code Library, ascl:2101.003
