Skip to content

Latest commit

 

History

History
47 lines (38 loc) · 1.1 KB

README.md

File metadata and controls

47 lines (38 loc) · 1.1 KB
Raw

TESS-Atlas


TESS Atlas

The python package used to run the analyses in the TESS-Atlas catalog.

Installation instructions

To install the package:

python -m pip install tess-atlas

or

git clone [email protected]:tess-atlas/tess-atlas.git
cd tess-atlas
python -m pip install -e .

How to use

Analyse a TOI

To run the analysis for one TOI, you can run

run_toi <toi id number>

where an example <toi id number> = 724

To only setup the notebook + data needed for the analysis for one TOI, you can run

run_toi <toi id number> --setup

Downloading results

You can __download completed analyses with

download_toi 103 --outdir analysed_tois

Publishing tess_atlas to pypi

To publish to pypi, you will need admin access to this repo. Then, publishing just requires you to change the version number tag a commit. The pypi_release Github action will (hopefully) take care of the rest.