Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Ghx defaults standardization #604

Merged
merged 8 commits into from
Dec 24, 2024
Prev Previous commit
Next Next commit
Update README.md
adfarth authored Sep 17, 2024
commit c3bb5a411b2ec94fb2db4b6bbd810c7c36695f6b
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -6,7 +6,7 @@ The REopt API provides concurrent, multiple technology integration and optimizat

## 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?
The REopt Julia package is the backend of the REopt API. That means that the optimization model is 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?

**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).