Installation instructions

Installation instructions#

Installation#

Root Directory#

It is recommended to install Hercules into a root directory. This root directory can also contain other projects that are often used with Hercules such as the Wind Hybrid Open Controller (WHOC) and the Electrolyzer.

mkdir -p hercules_root
cd hercules_root

Clone Hercules#

git clone https://github.com/NREL/hercules
cd hercules

Virtual environment#

It is recommended that you install Hercules into a virtual environment.

CONDA#

To create a new conda environment for hercules:

conda create --name hercules python=3.11
conda activate hercules

UV#

Alternatively, you can use uv to create a new environment for hercules. This will create a new environment in the current directory.

uv venv
source .venv/bin/activate

PIP Install#

Install Hercules in editible mode into the active virtual environment.

Just Hercules#

pip install -e .

With Developer and Documentation Dependencies#

pip install -e .[develop,docs]

Setting branch#

Can optionally switch to the v2 branch for the latest stable version.

git fetch --all
git switch v2

Wind Hybrid Open Controller (WHOC)#

NREL’s Wind Hybrid Open Controller (WHOC) software is used to implement controllers in the Hercules platform. This package is not essential to run Hercules by itself, but is needed to implement any controls in the platform.

To install: Go back to root

cd ..
git clone git@github.com:NREL/wind-hybrid-open-controller.git
cd wind-hybrid-open-controller
git fetch --all
pip install -e .

Electrolyzer#

A python electrolyzer model is also required for hercules. To install the electrolyzer, use

cd ..
git clone git@github.com:NREL/electrolyzer.git
cd electrolyzer
git fetch --all
git switch main
Contents