REopt API Analysis using Python

REopt is a techno-economic decision support model from NREL which is used for optimizing energy systems for buildings, campuses, communities, and microgrids. REopt Lite offers a no-cost subset of features from NREL’s more comprehensive REopt model. REopt Lite also offers an application programming interface (API). This is a guide to use REopt’s Application Programming Interface for running REopt analysis programmatically.

Detailed documentation of REopt Lite API is available here.

This repository has three different ways of interfacing with the api through the directories single_site, multi_site and notebooks. Each of these repositoris has a README.md file in them that describes the analysis workflow.

Usage

The easiest way to get started using the REopt Lite API it to access it through the Binder notebook. Otherwise you will need to set up your environment following the steps below.

Prerequisites

1. Obtain API_key from here

2. Install Python 3.6+ interpreter:

   • Ubuntu: sudo apt-get install python3-dev

   • Mac OSX: Download and install version 3.6+ from here

   • Windows: Download and install version 3.6+ from here

3. Install pip

   Recommended: use a virtual environment

4. Add the required python packages:

   • If using virtualenv: activate the environment

   • pip install -r requirements.txt

   NOTE: The requirements.txt does not include dependecies for the jupyter notebooks

5. (OPTIONAL) Install git: - https://git-scm.com/book/en/v2/Getting-Started-Installing-Git

Running the code

1. Clone (or download) the repository:

   git clone https://github.com/nrel/REopt-API-Analysis.git

2. Follow the README.md instructions in the multi_site or single_site directories