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

The preferred installation method is via ``pip`` in the virtual environment of your choice.

.. note::
    ``nessai`` requires Python 3.6 or greater.


Installing nessai
=================

PyTorch
-------

``nessai`` requires PyTorch will can be installed using ``pip`` or ``conda``. It's recommend to first install the correct version on PyTorch for your system and then proceed with the usual installation. See the PyTorch homepage for instructions: https://pytorch.org/.

.. note::
    ``nessai`` includes GPU support but it is not recommended as for the majority of use-cases the current implementation runs slower on the GPU than CPU. This may change with future optimisations.

Nessai
------

``nessai`` can be installed using ``pip``

.. code-block:: console

    $ pip install nessai

This will install the dependencies needed but the version of PyTorch will not necessarily be the correct version for your system unless you followed the previous step.

Nessai for development
----------------------

To install ``nessai`` for development purposes see the `contribution guidelines <https://github.com/mj-will/nessai/blob/master/CONTRIBUTING.md>`_.


Using nessai with bilby
=======================

``nessai`` is included in ``bilby`` version 1.1.0 onwards. For instructions on how to install ``bilby`` see `here <https://lscsoft.docs.ligo.org/bilby/index.html>`_.

For examples of how to run ``nessai`` via ``bilby`` see the `examples directory <https://github.com/mj-will/nessai/tree/main/examples>`_.