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.3.0.tar.gz (56.2 kB view details)

Uploaded Source

Built Distribution

ttvfast-0.3.0-cp35-cp35m-macosx_10_11_x86_64.whl (23.4 kB view details)

Uploaded CPython 3.5mmacOS 10.11+ x86-64

File details

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

File metadata

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

File hashes

Hashes for ttvfast-0.3.0.tar.gz
Algorithm Hash digest
SHA256 c024dd05ec0d7972c2974a4aeed5583b9b3cd3feb8642adc1e8266d53057b843
MD5 45db841a0fe0fcd0ee3e0caeb3c64fc7
BLAKE2b-256 86b83316358c853f0b5c776bbe9dc3ea8c93103345f82f0f9a9f68a086e36551

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ttvfast-0.3.0-cp35-cp35m-macosx_10_11_x86_64.whl
Algorithm Hash digest
SHA256 377e577ece208d4e7204d10af5d059b5627fefffd1559d54b9c6bc46774b860b
MD5 b5acdb03f48647fbd62b6a50a013460f
BLAKE2b-256 d187445ff204cf26f2d141837fa6db63ec96a106295e7959a96e5a082dc2ee09

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