Installation

Prerequisites

Episimmer requires python 3.7+.

Install using pip

If you are using Linux or macOS you can install episimmer from PyPI with pip:

pip install episimmer

Install from source

Or you can install from source

1. First clone this repository:

git clone https://github.com/healthbadge/episimmer.git

2. Then, to install the package, run the following command inside the episimmer directory:

pip install -e .

3. If you do not have pip you can instead use:

python setup.py install

If you do not have root access, you should add the --user option to the above lines.

Documentation

To build the documentation:

1. Install episimmer with command -

   pip install -e .[test]
   

   Note: Some shells such as Zsh require quotation marks around brackets, i.e. pip install -e ‘.[test]’

2. Generate the documentation file via:

   cd docs
   make html
   

The documentation is now available to view by opening docs/_build/html/index.html.