Skip to main content

Python package to fit relative astrometry with background star motion tracks.

Project description

https://github.com/wbalmer/backtracks/raw/main/docs/_static/backtracks-logo-light.svg

backtracks

https://img.shields.io/pypi/v/backtracks https://zenodo.org/badge/651267755.svg https://github.com/wbalmer/backtracks/actions/workflows/main.yml/badge.svg https://img.shields.io/readthedocs/backtracks https://img.shields.io/github/license/wbalmer/backtracks

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 Zenodo entry (here), and provide a footnote/acknowledgement linking to our package. An example bibtex citation is included below, but you may wish to cite a specific version of the package via zenodo instead. Thank you!

@software{backtracks_code,
     author       = {William O. Balmer and
                     Gilles P. P. L. Otten and
                     Tomas Stolker},
     title        = {backtracks: a python package to compare relative astrometry with background helical motion: v0.6},
     month        = feb,
     year         = 2025,
     publisher    = {Zenodo},
     version      = {v0.6},
     doi          = {10.5281/zenodo.14838369},
     url          = {https://doi.org/10.5281/zenodo.14838369},
   }

Details

  • High precision relative astrometry calculations with USNO’s NOVAS via the python implementation<https://pypi.org/project/novas/>. Thanks to Brandon Rhodes for maintaining this python package.

  • eDR3 Distance prior summary file from Bailer-Jones et al. (2021).

  • Example of HD 131399Ab uses data from Wagner et al. (2022) and Nielsen et al. (2017). Thank you to Kevin Wagner for providing the latest astrometry!

  • Log-likelihood and some utility functions borrowed heavily from orbitize! (BSD 3-clause).

  • PPF of multivariate normal borrowed from pints (BSD 3-clause).

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 backtrack
$ conda activate backtrack
$ 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 backtrack
$ conda activate backtrack
$ conda install pip
$ git clone https://github.com/wbalmer/backtrack.git
$ cd backtrack
$ pip install -e .

Then, test your installation:

>>> from backtracks import System

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

backtracks-0.6.4.tar.gz (12.6 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

backtracks-0.6.4-py3-none-any.whl (360.9 kB view details)

Uploaded Python 3

File details

Details for the file backtracks-0.6.4.tar.gz.

File metadata

  • Download URL: backtracks-0.6.4.tar.gz
  • Upload date:
  • Size: 12.6 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.13

File hashes

Hashes for backtracks-0.6.4.tar.gz
Algorithm Hash digest
SHA256 1bae34b2303f70db96079269726de88d2678daeea26be77fa1cb046b327fa8c5
MD5 c771645cdee080b4f71dedeeab49981e
BLAKE2b-256 4c7cc63df369c44b1a2620a3652ae97351860f231266ade275f91eb522995af5

See more details on using hashes here.

File details

Details for the file backtracks-0.6.4-py3-none-any.whl.

File metadata

  • Download URL: backtracks-0.6.4-py3-none-any.whl
  • Upload date:
  • Size: 360.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.13

File hashes

Hashes for backtracks-0.6.4-py3-none-any.whl
Algorithm Hash digest
SHA256 31f4fb6ce7b7932f1d56e2e1a483ca10410208ff56af79592ef70f730aad9c03
MD5 606852ada52e255440a39aa383d5bac1
BLAKE2b-256 d28c1b26c3743a6328804b857f61967678ab2397aa4f2da483d6e554d0a05be6

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page