squishyplanet


Namesquishyplanet JSON
Version 0.3.1 PyPI version JSON
download
home_pageNone
SummaryA package for dealing with non-spherical exoplanets
upload_time2024-10-26 00:42:04
maintainerNone
docs_urlNone
authorNone
requires_python>=3.9
licenseMIT
keywords astronomy exoplanets
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # squishyplanet

[![DOI](https://joss.theoj.org/papers/10.21105/joss.06972/status.svg)](https://doi.org/10.21105/joss.06972)
[![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)
 [![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)

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


``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}
}
```

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "squishyplanet",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.9",
    "maintainer_email": null,
    "keywords": "astronomy, exoplanets",
    "author": null,
    "author_email": "Ben Cassese <b.c.cassese@columbia.edu>",
    "download_url": "https://files.pythonhosted.org/packages/b4/79/fca4b470b174cca8e942107579561ae9428d328a266650194e4770f97a46/squishyplanet-0.3.1.tar.gz",
    "platform": null,
    "description": "# squishyplanet\n\n[![DOI](https://joss.theoj.org/papers/10.21105/joss.06972/status.svg)](https://doi.org/10.21105/joss.06972)\n[![Documentation Status](https://readthedocs.org/projects/squishyplanet/badge/?version=latest)](https://squishyplanet.readthedocs.io/en/latest/?badge=latest)\n![Build Status](https://github.com/ben-cassese/squishyplanet/actions/workflows/tests.yml/badge.svg)\n[![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)\n![PyPI - Version](https://img.shields.io/pypi/v/squishyplanet)\n [![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)\n\nA package for modeling non-spherical exoplanets.\n\n![image](docs/_static/media/videos/_static/480p15/Banner_ManimCE_v0.17.3.gif)\n\n## Documentation\n\nThe 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.\n\n## Installation\n\nYou can install ``squishyplanet`` from PyPI with pip:\n\n```bash\npython -m pip install squishyplanet\n```\n\nSee the [installation instructions](https://squishyplanet.readthedocs.io/en/latest/installation.html) for more details.\n\n## Attribution and License\n\n\n``squishyplanet`` is made freely available under the MIT License. If you use this code in your research, please cite the accompanying JOSS paper:\n\n```\n@article{squishyplanet,\n       author = {{Cassese}, Ben and {Vega}, Justin and {Lu}, Tiger and {Rice}, Malena and {Poddar}, Avishi and {Kipping}, David},\n        title = \"{squishyplanet: modeling transits of non-spherical exoplanets in JAX}\",\n      journal = {The Journal of Open Source Software},\n     keywords = {astronomy, exoplanets, exoplanet transits, Python, Jupyter Notebook, Astrophysics - Instrumentation and Methods for Astrophysics, Astrophysics - Earth and Planetary Astrophysics},\n         year = 2024,\n        month = aug,\n       volume = {9},\n       number = {100},\n          eid = {6972},\n        pages = {6972},\n          doi = {10.21105/joss.06972},\narchivePrefix = {arXiv},\n       eprint = {2409.00167},\n primaryClass = {astro-ph.IM},\n       adsurl = {https://ui.adsabs.harvard.edu/abs/2024JOSS....9.6972C},\n      adsnote = {Provided by the SAO/NASA Astrophysics Data System}\n}\n```\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "A package for dealing with non-spherical exoplanets",
    "version": "0.3.1",
    "project_urls": {
        "Documentation": "https://squishyplanet.readthedocs.io/en/latest/",
        "Homepage": "https://github.com/ben-cassese/squishyplanet"
    },
    "split_keywords": [
        "astronomy",
        " exoplanets"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "164b8ebe9e01647723dd8223aa7c7d5b8a10262605ab1cbc04d1bb433cb9e5b7",
                "md5": "5943a668165ece5b22ef9d8764ff0d42",
                "sha256": "bd3905c16d41bc632d459e1fa35425f16633d2b810d6b308ab82a1873148b1b4"
            },
            "downloads": -1,
            "filename": "squishyplanet-0.3.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "5943a668165ece5b22ef9d8764ff0d42",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.9",
            "size": 48326,
            "upload_time": "2024-10-26T00:42:03",
            "upload_time_iso_8601": "2024-10-26T00:42:03.150289Z",
            "url": "https://files.pythonhosted.org/packages/16/4b/8ebe9e01647723dd8223aa7c7d5b8a10262605ab1cbc04d1bb433cb9e5b7/squishyplanet-0.3.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "b479fca4b470b174cca8e942107579561ae9428d328a266650194e4770f97a46",
                "md5": "757462a00f0d6a4829e7821a3acc980f",
                "sha256": "66ef68d43982ebb0da0ca5effadecde6648c4aee9122c46b6beae81d4a17d949"
            },
            "downloads": -1,
            "filename": "squishyplanet-0.3.1.tar.gz",
            "has_sig": false,
            "md5_digest": "757462a00f0d6a4829e7821a3acc980f",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.9",
            "size": 48893,
            "upload_time": "2024-10-26T00:42:04",
            "upload_time_iso_8601": "2024-10-26T00:42:04.609580Z",
            "url": "https://files.pythonhosted.org/packages/b4/79/fca4b470b174cca8e942107579561ae9428d328a266650194e4770f97a46/squishyplanet-0.3.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-10-26 00:42:04",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "ben-cassese",
    "github_project": "squishyplanet",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "tox": true,
    "lcname": "squishyplanet"
}
        
Elapsed time: 0.89303s