Skip to main content
https://img.shields.io/badge/GitHub-stevengiacalone%2Ftriceratops-blue.svg?style=flat https://github.com/stevengiacalone/triceratops/actions/workflows/tests.yml/badge.svg http://img.shields.io/badge/license-MIT-blue.svg?style=flat http://img.shields.io/badge/arXiv-2002.00691-orange.svg?style=flat

A tool for vetting and validating TESS Objects of Interest.

See Giacalone et al. (2021) for more information about this tool.

For a modified version of the code that can simultaneously analyze transits observed in different photometric passbands (i.e., both TESS data and ground-based data), see this repo.

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.

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. 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

Metadata

Release files for triceratops 1.1.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for triceratops 1.1.0
File Size Uploaded Provenance Actions
triceratops-1.1.0.tar.gz 105.5 kB Without provenance Details for triceratops-1.1.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for triceratops 1.1.0
File Interpreter ABI Platform Actions
triceratops-1.1.0-py3-none-any.whl Python 3 none any Details for triceratops-1.1.0-py3-none-any.whl

Total release size: 187.4 kB

Release files / triceratops-1.1.0.tar.gz

Download URL triceratops-1.1.0.tar.gz
Size 105.5 kB
Tags Source
SHA-256 checksum
How to use checksums
1bdb05548cba1d4556eb67e901eede6f31579ac67a09e50c5f628c73148b0f65
BLAKE2b-256 checksum
How to use checksums
576bdae82c6973539df04e06bc3e998d964cfc99f183a1a8ca3a62e580605e39
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.8.8

Release files / triceratops-1.1.0-py3-none-any.whl

Download URL triceratops-1.1.0-py3-none-any.whl
Size 81.8 kB
Tags Python 3
SHA-256 checksum
How to use checksums
94c090b149fdc9b82d4f93f3f3c497ae4a77ebf638128d7458f2bdd170015b39
BLAKE2b-256 checksum
How to use checksums
40ae4c90047abeff03305a96e63a93bb50c7fc258078bbe7ebfc7d6eae60faf9
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.8.8

Security for triceratops 1.1.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page