Quick Start Guide

Pre-requisites

• Julia: HolisticElectricityModel is written in Julia. Instructions to install Julia can be found in the julia website. If this is your first time using Julia visit the official Getting started with Julia.

• Solvers: Running HEM requires access to LP and MIP solvers. Because different choices can be made in this regard, we recommend setting up your computational environment based on one of the environments under runner. At NREL we recommend using Gurobi for HPC and Xpress for local runs.

• Data: The data for which the simulation will be run needs to be pre-populated and placed in the local directory. Instructions on how to generate run inputs can be found in the HolisticElectricityModelData.jl repository.

Running Your First Model

Running on NREL HPC

• Set up the model configurations using the hem_config.yaml file in HolisticElectricityModel.jl/script/configs/. Make sure that the solver is 'Gurobi'.

• Load the Gurobi module

> module load gurobi/11.0.2

and then use the `hem.jl` script for your model runs.

For example, to run in interactive mode on a debug node:

> salloc -N 1 -t 60 --account=hem --partition=debug
# ... Wait for a compute node
> cd HolisticElectricityModel.jl
> module load gurobi/11.0.2
> julia --project=runner/Gurobi script/hem.jl

Running on NREL Laptop

• Ensure that Xpress is installed and activated.

• Set up the model configurations using the hem_config.yaml file in HolisticElectricityModel.jl/script/configs/. Make sure that the solver is 'Xpress'.

• Activate the runner/Xpress environment and run the hem.jl script.

$ cd HolisticElectricityModel.jl
$ julia --project=runner/Xpress script/hem.jl