Skip to content

Commit

Permalink
Merge pull request #485 from NREL/develop
Browse files Browse the repository at this point in the history
V3 Additions and Bug Fixes Summer 2023
  • Loading branch information
Bill-Becker authored Sep 4, 2023
2 parents 729b011 + 8a4fd4e commit 88dbb42
Show file tree
Hide file tree
Showing 24 changed files with 1,364 additions and 459 deletions.
6 changes: 5 additions & 1 deletion .helm/values.staging.yaml
Original file line number Diff line number Diff line change
@@ -1,2 +1,6 @@
appEnv: staging
djangoSettingsModule: reopt_api.staging_settings
djangoSettingsModule: reopt_api.staging_settings
juliaCpuRequest: "1000m"
juliaCpuLimit: "4000m"
juliaMemoryRequest: "8000Mi"
juliaMemoryLimit: "8000Mi"
13 changes: 10 additions & 3 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,13 +26,20 @@ Classify the change according to the following categories:
##### Removed
### Patches

## Develop 2023-08-07
## v2.15.0
### Minor Updates
##### Added
- Add `GHP` to `job` app for v3
- Add `/ghp_efficiency_thermal_factors` endpoint to `job` app for v
- Add `GHP` to `reoptjl` app for v3
- Add `Boiler` to `reoptjl` app for v3 along with appropriate tests
- Add `SteamTurbine` to `reoptjl` app for v3 along with appropriate tests
- Add `/ghp_efficiency_thermal_factors` endpoint to `reoptjl` app for v3
- Add `/get_existing_chiller_default_cop` endpoint to `reoptjl` app for v3
- Add `/get_chp_defaults` endpoint to `reoptjl` app
##### Changed
- Update a couple of GHP functions to use the GhpGhx.jl package instead of previous Julia scripts and data from v2
- Update `julia_src/` TOML files to point to **REopt.jlv0.32.6**
##### Fixed
- Fixed a type mismatch bug in the `simulated_load` function within http.jl

## v2.14.0
### Minor Updates
Expand Down
10 changes: 6 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,27 +5,29 @@ The REopt® model in this repository is a free, open-source, development version
The REopt API provides concurrent, multiple technology integration and optimization capabilities to help organizations meet their cost savings, energy performance, resilience, and emissions reduction goals. Formulated as a mixed integer linear program, the REopt model recommends an optimally sized mix of renewable energy, conventional generation, and energy storage technologies; estimates the net present value of implementing those technologies; and provides a dispatch strategy for operating the technology mix at maximum economic efficiency. A list of the REopt model capabilities is provided [here](https://reopt.nrel.gov/about/capabilities.html). Example projects using REopt can be viewed [here](https://reopt.nrel.gov/projects/).

## Should I be using or modifying the REopt API or the REopt Julia Package?

The REopt Julia package will soon become the backend of the REopt API. That means that the optimization model will be contained in [REopt.jl](https://github.com/NREL/REopt.jl), and that a user could supply the same inputs to the API and Julia package and get the same results. So which should you use?
**When and how to use the REopt Julia package:**

**1. When and how to _use_ the REopt Julia package:**
- You want to be able to use the REopt model without incorporating an API call (and associated rate limits).
- You want slightly more flexibility in how you interact with model inputs, optimization parameters, and run types.
- You can install an optimization solver for use with REopt.
- You do not need your results saved in an external database.
- **How do I use the REopt Julia package?:** see instructions [here](https://nrel.github.io/REopt.jl/dev/).

**When and how to modify the REopt Julia package:**
**2. When and how to _modify_ the REopt Julia package:**
- You want to make changes to the REopt model beyond modifying input values (e.g., add a new technology).
- You want to suggest a bug fix in the REopt model.
- **How do I modify the REopt Julia package?:** get the (free, open-source) model [here](https://github.com/NREL/REopt.jl) and see additional instructions [here](https://nrel.github.io/REopt.jl/dev/).

**When and how to use the REopt_API:**
**3. When and how to _use_ the REopt_API:**
- You do not want to modify the code or host the API on your own server.
- You do not want to install or use your own optimization solver (simply POSTing to the REopt API does not require a solver, whereas using the Julia package does).
- You want to be able to access or share results saved in a database using a runuuid.
- You want to be able to view your API results in the REopt web tool using a runuuid. (we can do this?)
- **How do I use the REopt API?:** you can access our production version of the API via the [NREL Developer Network](https://developer.nrel.gov/docs/energy-optimization/reopt/). You can view examples of using the API in the [REopt-API-Analysis Repo](https://github.com/NREL/REopt-API-Analysis/wiki).

**When and how to modify the REopt_API:**
**4. When and how to _modify_ the REopt_API:**
- You have made changes to the REopt Julia package that include modified inputs or outputs, and want to reflect those in the REopt API.
- You want to suggest a bug fix in the REopt API or add or modify validation or API endpoints.
- You want to host the API on your own servers.
Expand Down
Loading

0 comments on commit 88dbb42

Please sign in to comment.