Home

This wiki is currently under construction as we transition the REopt API from v2 to v3

Welcome to the REopt API Wiki!

The code in this repository is the REopt API, served on developer.nrel.gov/api/reopt, which is available to the public and also acts as the back end to the REopt Web Tool. The instructions and information in this wiki are useful for:

• NREL REopt developers;
• external contributors;
• and those that wish to host the API in a local develop environment.

NOTE: For those that would like to host the API in a production environment: you can learn about how the API is structured and run in a develop environment here, but given that hosting the API in production can be done many ways and comes with cybersecurity concerns (if you expect to use any private data for example) - this documentation does not address hosting the API in production.

This REopt API Wiki is structured as follows:

1. Structure of the API
2. Setup Docker for Local API Development
3. URLs to Call Locally-Hosted API
4. Develop and Test the API (v3+)
5. Deprecated: Develop and Test the API (v1-v2)

There are several additional REopt guides and resources for different REopt user types:

• REopt_API Analysis (for using, but not developing, the REopt API): https://github.com/NREL/REopt-API-Analysis/wiki
• REopt.jl Documentation (for using or developing the Julia Package): https://nrel.github.io/REopt.jl/dev/
• REopt Discussion Forum (for user questions and updates from the REopt team): https://github.com/NREL/REopt-API-Analysis/discussions
• REopt User Manual (for detailed description of the model, including mathematical documentation): https://reopt.nrel.gov/tool/reopt-user-manual.pdf

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.

This REopt_API wiki is structured as follows:

1. Structure of the API
2. Running the API locally for development
   • Using Docker for local development
     • External (non-NREL) Xpress setup for Docker container
     • Troubleshooting Docker
   • URLs for calling the API
   • Setup to evaluate GHP locally
3. Developing the API
   • Testing and debugging in Docker with Visual Studio Code
4. Transition to /v3 using REopt.jl
   • v3 development troubleshooting
5. Contribution guidelines
6. REopt mathematical model documentation