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.

Source Distribution

ttvfast-0.2.1.tar.gz (72.2 kB view details)

Uploaded Source

Built Distribution

ttvfast-0.2.1-cp35-cp35m-macosx_10_11_x86_64.whl (23.2 kB view details)

Uploaded CPython 3.5mmacOS 10.11+ x86-64

File details

Details for the file ttvfast-0.2.1.tar.gz.

File metadata

  • Download URL: ttvfast-0.2.1.tar.gz
  • Upload date:
  • Size: 72.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for ttvfast-0.2.1.tar.gz
Algorithm Hash digest
SHA256 300be351948b89ee6b257bbfcaf9a096d928bcddd8661adde2e8b7b6b15e6582
MD5 fc466423d571fd3379df42c1515ecd08
BLAKE2b-256 48fa647174a47c74ae23d174c5a1a4053a9c3970c2cfdec935a52258e4a5a0c1

See more details on using hashes here.

File details

Details for the file ttvfast-0.2.1-cp35-cp35m-macosx_10_11_x86_64.whl.

File metadata

File hashes

Hashes for ttvfast-0.2.1-cp35-cp35m-macosx_10_11_x86_64.whl
Algorithm Hash digest
SHA256 f74d2915de46086f92c1f3272dd2638a79f075c3f55c3ceb9f137cfc00743927
MD5 d36f1ffd0d5905c39225699f6dcdd9bb
BLAKE2b-256 6a96c00ced03a8a7a0a9e065156fbe5f518020a3e44821ce09ac93399294ce46

See more details on using hashes here.

Supported by

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