ejhigson/dyPolyChord

.. _install:

Installation
============

``dyPolyChord`` is compatible with python 2.7 and >=3.4, and can be installed with `pip <http://www.pip-installer.org/>`_:

.. code-block:: bash

   pip install dyPolyChord


Alternatively, you can download the latest version and install it by cloning `the github
repository <https://github.com/ejhigson/dyPolyChord>`_:

.. code-block:: bash

    git clone https://github.com/ejhigson/dyPolyChord.git
    cd dyPolyChord
    python setup.py install

Note that the github repository may include new changes which have not yet been released on PyPI (and therefore will not be included if installing with pip).

Dependencies
------------

``dyPolyChord`` requires:

 - ``PolyChord`` >=v1.14;
 - ``numpy`` >=v1.13;
 - ``scipy`` >=v1.0.0;
 - ``nestcheck`` >=v0.1.8.


``PolyChord`` is available at https://github.com/PolyChord/PolyChordLite and has its own installation and licence instructions; see the link for more information.
Note running ``dyPolyChord`` with compiled C++ or Fortran likelihoods does not require the installation of ``PolyChord``'s Python interface.


Tests
-----

You can run the test suite with `nose <http://nose.readthedocs.org/>`_. From the root of the ``dyPolyChord`` directory, run:

.. code-block:: bash

    nosetests

To also get code coverage information (this requires the ``coverage`` package), use:

.. code-block:: bash

    nosetests --with-coverage --cover-erase --cover-package=dyPolyChord

Note that these tests will run without ``PolyChord``. This is to allow all the ``dyPolyChord`` code (including code specifically for Python or compiled likelihoods) to be tested without the need for the user to compile any executables or install ``pypolychord``.
If ``pypolychord`` is installed, the tests will also run calculations using Python likelihoods and check their results (otherwise these tests are skipped).