https://github.com/dfm/tess-atlas
https://github.com/dfm/tess-atlas
Last synced: about 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/dfm/tess-atlas
- Owner: dfm
- License: mit
- Created: 2019-03-25T18:13:46.000Z (about 7 years ago)
- Default Branch: main
- Last Pushed: 2023-10-03T08:04:08.000Z (over 2 years ago)
- Last Synced: 2025-04-12T13:12:27.481Z (about 1 year ago)
- Language: Python
- Size: 60.7 MB
- Stars: 9
- Watchers: 5
- Forks: 8
- Open Issues: 17
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Citation: CITATION.cff
Awesome Lists containing this project
README
# TESS-Atlas
TESS Atlas
The python package used to run the analyses in the TESS-Atlas catalog.
## Installation instructions
To install the package:
```bash
python -m pip install tess-atlas
```
or
```bash
git clone git@github.com: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
```bash
run_toi
```
where an example ` = 724`
To only setup the notebook + data needed for the analysis for one TOI, you can run
```bash
run_toi --setup
```
### Downloading results
You can __download completed analyses with
```bash
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.