Skip to content
adfarth edited this page Aug 30, 2023 · 22 revisions

image

Welcome to the REopt-API-Analysis wiki!

The REopt® model recommends an optimal mix of renewable energy, conventional generation, and energy storage technologies to meet cost savings and energy performance goals, including the hourly optimal operation of the system.

NOTE: The documentation in this wiki is for using the REopt API. For documentation on developing the REopt API please go here. For documentation on using the REopt Julia package, please go here (see the REopt API README for more information about when and how to use the API vs. Julia package). Also note that the REopt Web Tool provides a free interface for interactively setting up input parameters, and can meet most users' needs.

Please use the Discussions page for general usage questions.

Outline of this Wiki:

Using the REopt API (V3+)

  1. Get API key and setup local environment
  2. Run analyses using the API
  3. V3 input and output changes
  4. API endpoints
  5. Custom Electric Rates
  6. Common Errors

Using the REopt Julia Package

  1. Scripts to use the REopt Julia Package

Deprecated: Using the V1-V2 REopt API

  1. V2 "job" inputs and outputs
  2. V2 endpoints

NOTE: The REopt web tool has dropped “Lite” from its name to better reflect its status as a comprehensive techno-economic optimization tool that evaluates the economics of distributed solar, wind, battery storage, combined heat and power, geothermal heat pumps, modeled greenhouse gas reductions, and more. Read about REopt's evolution.