Requirements and Installation

Requirements

Software

  • Python 3.6+

  • Git

Python Modules

Tool API. This API provides a standard way for all tools to be wrapped to allow for a common interface layer.

Installation

Directly from GitHub:

git clone https://github.com/inab/vre_template_tool.git
cd vre_template_tool

Create Python environment:

python3 -m venv venv
source venv/bin/activate
pip install --upgrade wheel
pip install -r requirements.txt

Documentation

To build the documentation:

cd docs
pip install -r requirements.txt
make html

Documentation will be generated (in HTML format) inside the _build/html directory.