triceratops


Nametriceratops JSON
Version 1.0.19 PyPI version JSON
download
home_pagehttps://github.com/stevengiacalone/triceratops
SummaryStatistical Validation of Transiting Planet Candidates
upload_time2024-07-29 19:24:29
maintainerNone
docs_urlNone
authorSteven Giacalone
requires_pythonNone
licenseNone
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            triceratops
===========

.. image:: https://img.shields.io/badge/GitHub-stevengiacalone%2Ftriceratops-blue.svg?style=flat
    :target: https://github.com/stevengiacalone/triceratops
.. image:: http://img.shields.io/badge/license-MIT-blue.svg?style=flat
    :target: https://github.com/stevengiacalone/triceratops/blob/master/LICENSE
.. image:: http://img.shields.io/badge/arXiv-2002.00691-orange.svg?style=flat
    :target: https://arxiv.org/abs/2002.00691

A tool for vetting and validating TESS Objects of Interest.

See `Giacalone et al. (2021) <https://ui.adsabs.harvard.edu/abs/2021AJ....161...24G/abstract>`_ for more information about this tool.

Installation
-------------

You can install the most recently released version of this tool via PyPI::

    $ pip install triceratops


Usage
-------------

``triceratops`` can be easily used with jupyter notebook (with Python 3.6 or higher). See the notebook in the examples/ directory for a brief tutorial or check out the `documentation <https://triceratops.readthedocs.io/en/latest/>`_.

Attribution
-------------
If you use ``triceratops``, please cite both the paper and the code.

Paper citation::

    @ARTICLE{2021AJ....161...24G,
           author = {{Giacalone}, Steven and {Dressing}, Courtney D. and {Jensen}, Eric L.~N. and {Collins}, Karen A. and {Ricker}, George R. and {Vanderspek}, Roland and {Seager}, S. and {Winn}, Joshua N. and {Jenkins}, Jon M. and {Barclay}, Thomas and {Barkaoui}, Khalid and {Cadieux}, Charles and {Charbonneau}, David and {Collins}, Kevin I. and {Conti}, Dennis M. and {Doyon}, Ren{\'e} and {Evans}, Phil and {Ghachoui}, Mourad and {Gillon}, Micha{\"e}l and {Guerrero}, Natalia M. and {Hart}, Rhodes and {Jehin}, Emmanu{\"e}l and {Kielkopf}, John F. and {McLean}, Brian and {Murgas}, Felipe and {Palle}, Enric and {Parviainen}, Hannu and {Pozuelos}, Francisco J. and {Relles}, Howard M. and {Shporer}, Avi and {Socia}, Quentin and {Stockdale}, Chris and {Tan}, Thiam-Guan and {Torres}, Guillermo and {Twicken}, Joseph D. and {Waalkes}, William C. and {Waite}, Ian A.},
            title = "{Vetting of 384 TESS Objects of Interest with TRICERATOPS and Statistical Validation of 12 Planet Candidates}",
          journal = {\aj},
         keywords = {Exoplanet astronomy, Astrostatistics, Planet hosting stars, Exoplanets, 486, 1882, 1242, 498, Astrophysics - Earth and Planetary Astrophysics, Astrophysics - Instrumentation and Methods for Astrophysics, Astrophysics - Solar and Stellar Astrophysics},
             year = 2021,
            month = jan,
           volume = {161},
           number = {1},
              eid = {24},
            pages = {24},
              doi = {10.3847/1538-3881/abc6af},
    archivePrefix = {arXiv},
           eprint = {2002.00691},
     primaryClass = {astro-ph.EP},
           adsurl = {https://ui.adsabs.harvard.edu/abs/2021AJ....161...24G},
          adsnote = {Provided by the SAO/NASA Astrophysics Data System}
    }

Code citation::

    @MISC{2020ascl.soft02004G,
           author = {{Giacalone}, Steven and {Dressing}, Courtney D.},
            title = "{triceratops: Candidate exoplanet rating tool}",
         keywords = {Software, NASA, TESS},
             year = 2020,
            month = feb,
              eid = {ascl:2002.004},
            pages = {ascl:2002.004},
    archivePrefix = {ascl},
           eprint = {2002.004},
           adsurl = {https://ui.adsabs.harvard.edu/abs/2020ascl.soft02004G},
          adsnote = {Provided by the SAO/NASA Astrophysics Data System}
    }

Help
-------------

If you are having trouble getting ``triceratops`` working on your machine, I recommend installing it in a fresh conda environment. You can download the latest distribution of anaconda `here <https://www.anaconda.com/distribution/>`_. After doing so, run the following in terminal::

    $ conda create -n myenv python=3.8
    $ conda activate myenv
    (myenv) $ pip install triceratops jupyterlab

You can replace ``myenv`` with an environment name of your choice. To exit this environment, run::

    (myenv) $ conda deactivate

To delete this environment, run::

    $ conda remove --name myenv --all



            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/stevengiacalone/triceratops",
    "name": "triceratops",
    "maintainer": null,
    "docs_url": null,
    "requires_python": null,
    "maintainer_email": null,
    "keywords": null,
    "author": "Steven Giacalone",
    "author_email": "steven_giacalone@berkeley.edu",
    "download_url": null,
    "platform": null,
    "description": "triceratops\n===========\n\n.. image:: https://img.shields.io/badge/GitHub-stevengiacalone%2Ftriceratops-blue.svg?style=flat\n    :target: https://github.com/stevengiacalone/triceratops\n.. image:: http://img.shields.io/badge/license-MIT-blue.svg?style=flat\n    :target: https://github.com/stevengiacalone/triceratops/blob/master/LICENSE\n.. image:: http://img.shields.io/badge/arXiv-2002.00691-orange.svg?style=flat\n    :target: https://arxiv.org/abs/2002.00691\n\nA tool for vetting and validating TESS Objects of Interest.\n\nSee `Giacalone et al. (2021) <https://ui.adsabs.harvard.edu/abs/2021AJ....161...24G/abstract>`_ for more information about this tool.\n\nInstallation\n-------------\n\nYou can install the most recently released version of this tool via PyPI::\n\n    $ pip install triceratops\n\n\nUsage\n-------------\n\n``triceratops`` can be easily used with jupyter notebook (with Python 3.6 or higher). See the notebook in the examples/ directory for a brief tutorial or check out the `documentation <https://triceratops.readthedocs.io/en/latest/>`_.\n\nAttribution\n-------------\nIf you use ``triceratops``, please cite both the paper and the code.\n\nPaper citation::\n\n    @ARTICLE{2021AJ....161...24G,\n           author = {{Giacalone}, Steven and {Dressing}, Courtney D. and {Jensen}, Eric L.~N. and {Collins}, Karen A. and {Ricker}, George R. and {Vanderspek}, Roland and {Seager}, S. and {Winn}, Joshua N. and {Jenkins}, Jon M. and {Barclay}, Thomas and {Barkaoui}, Khalid and {Cadieux}, Charles and {Charbonneau}, David and {Collins}, Kevin I. and {Conti}, Dennis M. and {Doyon}, Ren{\\'e} and {Evans}, Phil and {Ghachoui}, Mourad and {Gillon}, Micha{\\\"e}l and {Guerrero}, Natalia M. and {Hart}, Rhodes and {Jehin}, Emmanu{\\\"e}l and {Kielkopf}, John F. and {McLean}, Brian and {Murgas}, Felipe and {Palle}, Enric and {Parviainen}, Hannu and {Pozuelos}, Francisco J. and {Relles}, Howard M. and {Shporer}, Avi and {Socia}, Quentin and {Stockdale}, Chris and {Tan}, Thiam-Guan and {Torres}, Guillermo and {Twicken}, Joseph D. and {Waalkes}, William C. and {Waite}, Ian A.},\n            title = \"{Vetting of 384 TESS Objects of Interest with TRICERATOPS and Statistical Validation of 12 Planet Candidates}\",\n          journal = {\\aj},\n         keywords = {Exoplanet astronomy, Astrostatistics, Planet hosting stars, Exoplanets, 486, 1882, 1242, 498, Astrophysics - Earth and Planetary Astrophysics, Astrophysics - Instrumentation and Methods for Astrophysics, Astrophysics - Solar and Stellar Astrophysics},\n             year = 2021,\n            month = jan,\n           volume = {161},\n           number = {1},\n              eid = {24},\n            pages = {24},\n              doi = {10.3847/1538-3881/abc6af},\n    archivePrefix = {arXiv},\n           eprint = {2002.00691},\n     primaryClass = {astro-ph.EP},\n           adsurl = {https://ui.adsabs.harvard.edu/abs/2021AJ....161...24G},\n          adsnote = {Provided by the SAO/NASA Astrophysics Data System}\n    }\n\nCode citation::\n\n    @MISC{2020ascl.soft02004G,\n           author = {{Giacalone}, Steven and {Dressing}, Courtney D.},\n            title = \"{triceratops: Candidate exoplanet rating tool}\",\n         keywords = {Software, NASA, TESS},\n             year = 2020,\n            month = feb,\n              eid = {ascl:2002.004},\n            pages = {ascl:2002.004},\n    archivePrefix = {ascl},\n           eprint = {2002.004},\n           adsurl = {https://ui.adsabs.harvard.edu/abs/2020ascl.soft02004G},\n          adsnote = {Provided by the SAO/NASA Astrophysics Data System}\n    }\n\nHelp\n-------------\n\nIf you are having trouble getting ``triceratops`` working on your machine, I recommend installing it in a fresh conda environment. You can download the latest distribution of anaconda `here <https://www.anaconda.com/distribution/>`_. After doing so, run the following in terminal::\n\n    $ conda create -n myenv python=3.8\n    $ conda activate myenv\n    (myenv) $ pip install triceratops jupyterlab\n\nYou can replace ``myenv`` with an environment name of your choice. To exit this environment, run::\n\n    (myenv) $ conda deactivate\n\nTo delete this environment, run::\n\n    $ conda remove --name myenv --all\n\n\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "Statistical Validation of Transiting Planet Candidates",
    "version": "1.0.19",
    "project_urls": {
        "Homepage": "https://github.com/stevengiacalone/triceratops"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "fecd69fc95dcddc1959108fea3c74233861d197798013134c33da000e9562b1b",
                "md5": "5582c7dfad5bb4125ba3b71ddd5e8a2f",
                "sha256": "50f710218b067050a7be16164775e3b6d3064bd898ccafc1018b7cbc6b15a35b"
            },
            "downloads": -1,
            "filename": "triceratops-1.0.19-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "5582c7dfad5bb4125ba3b71ddd5e8a2f",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 64851,
            "upload_time": "2024-07-29T19:24:29",
            "upload_time_iso_8601": "2024-07-29T19:24:29.489850Z",
            "url": "https://files.pythonhosted.org/packages/fe/cd/69fc95dcddc1959108fea3c74233861d197798013134c33da000e9562b1b/triceratops-1.0.19-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-07-29 19:24:29",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "stevengiacalone",
    "github_project": "triceratops",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "lcname": "triceratops"
}
        
Elapsed time: 0.49738s