Metadata-Version: 1.1
Name: ttvfast
Version: 0.0.4
Summary: Python wrapper to ttvfast
Home-page: https://github.com/mindriot101/ttvfast-python
Author: Simon Walker
Author-email: s.r.walker101@googlemail.com
License: GPL
Description: =======
        TTVFast
        =======
        :Author: Simon Walker <s.r.walker101@googlemail.com>
        
        .. image:: https://travis-ci.org/mindriot101/ttvfast-python.svg?branch=master
            :target: https://travis-ci.org/mindriot101/ttvfast-python
        
        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
        
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: GNU General Public License v2 (GPLv2)
Classifier: Topic :: Scientific/Engineering :: Physics
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.6
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
