search

ben-cassese / squishyplanet

Transits of non-spherical exoplanets
https://squishyplanet.readthedocs.io/en/latest/
MIT License
4 stars 2 forks source link

readme

squishyplanet

DOI Documentation Status Build Status Coverage Status PyPI - Version License: MIT

A package for modeling non-spherical exoplanets.

image

Documentation

The docs for squishyplanet are hosted on Read the Docs. See those for installation instructions, example usage, and API documentation.

Installation

You can install squishyplanet from PyPI with pip:

python -m pip install squishyplanet

See the installation instructions for more details.

Attribution and License

squishyplanet is made freely available under the MIT License. If you use this code in your research, please cite the accompanying JOSS paper:

@article{squishyplanet,
       author = {{Cassese}, Ben and {Vega}, Justin and {Lu}, Tiger and {Rice}, Malena and {Poddar}, Avishi and {Kipping}, David},
        title = "{squishyplanet: modeling transits of non-spherical exoplanets in JAX}",
      journal = {The Journal of Open Source Software},
     keywords = {astronomy, exoplanets, exoplanet transits, Python, Jupyter Notebook, Astrophysics - Instrumentation and Methods for Astrophysics, Astrophysics - Earth and Planetary Astrophysics},
         year = 2024,
        month = aug,
       volume = {9},
       number = {100},
          eid = {6972},
        pages = {6972},
          doi = {10.21105/joss.06972},
archivePrefix = {arXiv},
       eprint = {2409.00167},
 primaryClass = {astro-ph.IM},
       adsurl = {https://ui.adsabs.harvard.edu/abs/2024JOSS....9.6972C},
      adsnote = {Provided by the SAO/NASA Astrophysics Data System}
}