Installation

Installing using PyPI

We recommend creating a new virtual environment before installing ERAD. Once the new virtual environment is ready, install ERAD using the following command.

pip install NREL-erad

Note

The version 0.1.0+ releases of ERAD have removed dependence on Neo4J Desktop, and simplified the installation and setup process. For graph based analysis, NetworkX will be used instead.

Installing in Development Mode

To install ERAD in development mode, clone the repository and install the dependencies using pip in a new environment:

git clone https://github.com/NREL-Distribution-Suites/erad.git
cd erad
pip install -e[dev,doc] .

This will install ERAD in editable mode, allowing you to make changes to the source code and have them reflected immediately.

Running Tests Locally

To run the test suite locally, use the following command from the root of the repository:

pytest tests/

This will execute all tests in the tests/ directory and report the results. Make sure you have installed all development dependencies before running the tests.