Metadata-Version: 2.1
Name: decorrelator
Version: 1.0.0
Summary: Easy-to-use Bayesian full and partial correlation estimator
Home-page: https://github.com/philastrophist/decorrelator
Author: philastrophist
Author-email: shaun.c.read@gmail.com
License: MIT
Platform: UNKNOWN
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Requires-Dist: numpy
Requires-Dist: matplotlib
Requires-Dist: tqdm
Requires-Dist: pymc3
Requires-Dist: statsmodels
Requires-Dist: astroML
Requires-Dist: chainconsumer
Requires-Dist: fastkde


|PyPI| |License| |Build Status| 

Decorrelator
------------

Analysing correlations between parameters whilst controlling for the
effects of others.

(Fancy partial correlation)

Installation
------------

-  create new environment

   -  ``conda create -n NAME python=3.7``

-  activate

   -  ``source activate NAME``

-  install high-performance libraries

   -  ``conda install numpy mkl scipy``

-  install correlator

   -  ``pip install git+https://github.com/philastrophist/decorrelator.git``

Use
---

Please see ``example.py`` for an example which uses nearly all
functionality

There are two objects of interest: \* ``decorrelator.LinearRelation`` \*
``decorrelator.CorrelationModel``

You may use them together as demonstrated in ``example.py`` or
indivdually as shown in their home modules under
``if __name__ == "__main__"``

.. |PyPI| image:: https://img.shields.io/pypi/v/candid.svg
   :target: https://pypi.python.org/pypi/candid/
.. |License| image:: https://img.shields.io/github/license/philastrophist/decorrelator.svg
   :target: https://github.com/philastrophist/decorrelator/blob/master/LICENSE.md
.. |Build Status| image:: https://travis-ci.com/philastrophist/candid.svg?token=3fPC1Wwg7aekKMkBjGPa&branch=master
   :target: https://travis-ci.com/philastrophist/candid


