.. _installation:

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

Basic installation instructions
-------------------------------

Fairensics was tested with Python 3.6 on OS X and Linux.
We recommend using `pip` for installation within an `virtualenv`_.

1. (Optionally) create a virtual environment.

.. code:: bash

    python3 -m venv fairensics-env
    source fairensics-env/bin/activate

2. Install the package.

.. code:: bash

    pip install fairensics

.. _virtualenv: https://virtualenv.pypa.io/en/stable/