From 8307e70040c2d267956c0591445f53b55e4cccfc Mon Sep 17 00:00:00 2001 From: Bill Becker <42586683+Bill-Becker@users.noreply.github.com> Date: Sat, 7 Sep 2024 08:36:27 -0600 Subject: [PATCH] Update the intro to the REopt.jl README.md Added context of how REopt.jl is used, and how it is the main/core module. Also added a general description of REopt pasted from the web tool page --- README.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 546328a13..5276b08fa 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,9 @@ # REopt® Julia package -This package is currently under development, but it now has all of the capabilities of the REopt® model used in the [REopt API](https://github.com/NREL/REopt_API). +REopt.jl is the core module of the [REopt® techno-economic decision support platform](https://www.nrel.gov/reopt/), developed by the National Renewable Energy Laboratory (NREL). REopt® stands for **R**enewable **E**nergy integration and **opt**imization. REopt.jl is used within the publicly-accessible and open-source [REopt API](https://github.com/NREL/REopt_API), and the publicly available [REopt Web Tool](https://reopt.nrel.gov/tool) calls the REopt API. -For more information please see the documentation: +The REopt® techno-economic decision support platform is used by researchers to optimize energy systems for buildings, campuses, communities, microgrids, and more. REopt identifies the optimal mix of renewable energy, conventional generation, storage, and electrification technologies to meet cost savings, resilience, emissions reductions, and energy performance goals. + +For more information about REopt.jl please see the Julia documentation: [![](https://img.shields.io/badge/docs-dev-blue.svg)](https://nrel.github.io/REopt.jl/dev)