Metadata-Version: 2.1
Name: transitfit
Version: 2.2.0
Summary: A package to fit exoplanet transit light curves
Home-page: https://github.com/joshjchayes/TransitFit
Author: Joshua Hayes
Author-email: joshjchayes@gmail.com
License: UNKNOWN
Project-URL: Documentation, https://transitfit.readthedocs.io/en/latest/index.html
Description: 
        # TransitFit
        
        **Author** - Joshua Hayes (joshjchayes@gmail.com), as part of the [SPEARNET collaboration (SPEARNET LINK)](deadlink).
        
        ## Overview
        TransitFit is designed for exoplanetary transmission spectroscopy studies and offers a flexible approach to fitting single or multiple transits of an exoplanet at different observation wavelengths.  It possesses the functionality to efficiently couple host limb-darkening parameters to a range of physical models across different wavelengths, through the use of the [Limb darkening toolkit (ldtk)](https://github.com/hpparvi/ldtk) and the [Kipping parameterisations of two-parameter limb darkening models](https://arxiv.org/abs/1308.0009). TransitFit uses [batman](https://www.cfa.harvard.edu/~lkreidberg/batman/index.html) to handle transit light curve modelling, and sampling and retrieval uses the nested sampling algorithm available through [dynesty](https://dynesty.readthedocs.io/en/latest/index.html).
        
        <a name="installation"></a>
        ## Installation
        
        Please note that TransitFit currently only runs on UNIX-based machines.
        
        Along with an installation of Python 3 (with the standard Conda distribution packages), TransitFit requires the following packages to be installed:
        
        - [dynesty](https://dynesty.readthedocs.io/en/latest/index.html)
        
        - [batman](https://www.cfa.harvard.edu/~lkreidberg/batman/index.html)
        
        - [Limb darkening toolkit (ldtk)](https://github.com/hpparvi/ldtk)
        
        
        <a name="guide"></a>
        ## User guide
        The documentation for TransitFit can be found [here (LINK TO FOLLOW)](deadlink)
        
        <a name="citing"></a>
        ## Citing TransitFit
        If you have used TransitFit in your work, please cite the [accompanying paper (LINK TO COME)](deadlink):
        
        ```
        SOME BIBTEX HERE
        ```
        
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Development Status :: 4 - Beta
Requires-Python: >=3.6
Description-Content-Type: text/markdown
