Installation Guide

User Installation

Usage of a virtual environment is strongly encouraged.

1. Clone the repository from github.

2. Install the requirements in commandline.

   1. Activate virtual environment if applicable.

   2. pip install -r /correct_path/EnsembleXAI/requirements.txt.

Downloading as a package (currently unavailable due to repository currently being private).

pip install git+https://github.com/anonymous-conference-journal/EnsembleXAI#egg=EnsembleXAI&subdirectory=EnsembleXAI

Package Development Additional Installation

To run documentation creation additional packages are required:

1. Nbsphinx extension to convert notebooks to html requires seperate installation of pandocs, installation with conda is recommended.

2. Optionally activate the virtual environment.

3. Run pip install sphinx sphinx_rtd_theme nbsphinx.

4. Optionally for a clean install run .\docs\make clean.

5. Then in the project directory run: .\docs\make html.