Skip to main content

Python wrapper to ttvfast

Project description

Author: Simon Walker <s.r.walker101@googlemail.com>
https://img.shields.io/pypi/v/ttvfast.svg?maxAge=2592000 https://travis-ci.org/mindriot101/ttvfast-python.svg?branch=master

A Python wrapper around Katherine Deck’s TTVFast C program (https://github.com/kdeck/TTVFast)

Installation

Install from pypi:

pip install ttvfast

or download and compile the code with

python setup.py build_ext --inplace

For the latest development version, install with pip:

pip install git+https://github.com/mindriot101/ttvfast.git

or clone from git:

git clone https://github.com/mindriot101/ttvfast-python.git
cd ttvfast-python
git submodule init
git submodule update # grabs code from TTVFast

then test that everything built properly using:

$ py.test
============================== test session starts ===============================
testing/test_lweiss.py .
testing/test_models.py ...
testing/test_python_api.py ...
testing/test_ttvfast.py ...

Usage

To compute the TTV properties for one or more planets:

  • build a ttvfast.models.Planet instance (see the class documentation for required parameters)
  • pass a list of the planets in the system to ttvfast.ttvfast along with:
    • the stellar mass in units of solar mass,
    • the start point of the integration in days,
    • the time step for the integration in days,
    • and the end point for integration in days.

The function ttvfast.ttvfast returns a dictionary containing positions and rv. The positions entry is a tuple of:

  1. a list of integer indices for which values correspond to which planet,
  2. a list of integers defining the epoch,
  3. a list of times,
  4. a list of rsky values, and
  5. a list of vsky values.

The optional rv_times parameter takes a list of RV times on which the RV is to be calculated. If so the rv entry in the output dictionary is populated with a list of RV values, and otherwise None.

For more details, see the original C module’s documentation: https://github.com/kdeck/TTVFast/blob/master/c_version/README

Citations

If you use this code, please cite Deck, Agol, Holman, & Nesvorny (2014), ApJ, 787, 132, arXiv:1403.1895.

-Katherine Deck, Eric Agol, Matt Holman, & David Nesvorny

Project details


Download files

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

Filename, size & hash SHA256 hash help File type Python version Upload date
ttvfast-0.3.0-cp35-cp35m-macosx_10_11_x86_64.whl (23.4 kB) Copy SHA256 hash SHA256 Wheel cp35
ttvfast-0.3.0.tar.gz (56.2 kB) Copy SHA256 hash SHA256 Source None

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page