Skip to content

Latest commit

 

History

History
88 lines (55 loc) · 3.92 KB

README.rst

File metadata and controls

88 lines (55 loc) · 3.92 KB
Shows an illustrated helix trailinb behind a planet with a question mark, lines are black in light mode and white in dark mode.

backtracks

https://img.shields.io/pypi/v/backtracks https://img.shields.io/readthedocs/backtracks https://img.shields.io/github/license/wbalmer/backtracks CodeFactor

backtracks is a python package to fit relative astrometry with background helical motion tracks, to discern directly imaged planets 🪐 from contaminant sources 💫 ⭐

The code is written and developed by Gilles Otten (@gotten), William Balmer (@wbalmer), and Tomas Stolker (@tomasstolker).

Documentation

Documentation can be found at http://backtracks.readthedocs.io.

Tutorial

A Jupyter notebook will show you how to use backtracks by reproducing the result in Nielsen et al. (2017) and Wagner et al. (2022) for the case of the former exoplanet candidate around HD 131339 A.

Attribution

If you use backtracks in your published work, please cite our Astrophysics Source Code Library entry, https://ascl.net/code/v/3755, and/or provide a footnote/acknowledgement linking to our package. Thank you!

Details

Installation

Currently requires and python 3.9-3.11 ish and astropy, corner, dynesty, matplotlib, numpy, novas, novas_de405, and their dependencies. Note that novas is not supported on Windows. You can create a working environment using conda+pip via a few lines of code:

$ conda create python=3.11 -n backtracks
$ conda activate backtracks
$ conda install pip
$ pip install backtracks

Or, to clone the repo and install in development mode (we recommend this, as the code is a work in progress and you can easily fix bugs you will likely encounter this way):

$ conda create python=3.11 -n backtracks
$ conda activate backtracks
$ conda install pip
$ git clone https://github.com/wbalmer/backtracks.git
$ cd backtracks
$ pip install -e .

Then, test your installation:

>>> from backtracks import System