Skip to content

Commit 1c1f921

Browse files
authored
Merge pull request #572 from NatLabRockies/docs-domain
Docs domain
2 parents a0f62a2 + 6ce34fc commit 1c1f921

File tree

98 files changed

+121
-120
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

98 files changed

+121
-120
lines changed

.github/workflows/CI.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,5 +22,5 @@ jobs:
2222
version: ${{ matrix.julia-version }}
2323
- uses: julia-actions/julia-buildpkg@latest
2424
# - uses: mxschmitt/action-tmate@v3 # for interactive debugging
25-
- run: julia --project=. -e 'using Pkg; Pkg.activate("test"); Pkg.rm("Xpress"); Pkg.activate("."); using TestEnv; TestEnv.activate(); Pkg.add(PackageSpec(name="GhpGhx", url="https://github.com/NREL/GhpGhx.jl.git")); using GhpGhx; cd("test"); include("runtests.jl")'
25+
- run: julia --project=. -e 'using Pkg; Pkg.activate("test"); Pkg.rm("Xpress"); Pkg.activate("."); using TestEnv; TestEnv.activate(); Pkg.add(PackageSpec(name="GhpGhx", url="https://github.com/NatLabRockies/GhpGhx.jl.git")); using GhpGhx; cd("test"); include("runtests.jl")'
2626
shell: bash

CHANGELOG.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,7 @@ Classify the change according to the following categories:
2828
## Develop
2929
### Fixed
3030
- Include boiler emissions in emissions calculations
31+
- Update links that broke with NLR domain change and update other references to NREL
3132
### Changed
3233
- Updated defaults for **Financial** inputs **elec_cost_escalation_rate_fraction**, **boiler_fuel_cost_escalation_rate_fraction**, **existing_boiler_fuel_cost_escalation_rate_fraction**, **chp_fuel_cost_escalation_rate_fraction**, **generator_fuel_cost_escalation_rate_fraction**, **om_cost_escalation_rate_fraction**, and **offtaker_discount_rate_fraction** when **sector** is "federal" (based on the 2025 NIST Handbook and Annual Supplement)
3334

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
# REopt® Julia package
2-
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 optimizes the sizing and dispatch of energy systems for buildings, campuses, communities, microgrids, and more. REopt identifies the cost-optimal mix of generation, storage, and heating and cooling technologies to meet cost savings, resilience, emissions reductions, and energy performance goals.
2+
REopt.jl is the core module of the [REopt® techno-economic decision support platform](https://www.nlr.gov/reopt/), developed by the National Laboratory of the Rockies (NLR). REopt optimizes the sizing and dispatch of energy systems for buildings, campuses, communities, microgrids, and more. REopt identifies the cost-optimal mix of generation, storage, and heating and cooling technologies to meet cost savings, resilience, emissions reductions, and energy performance goals.
33

4-
REopt.jl (this package) 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.
4+
REopt.jl (this package) is used within the publicly-accessible and open-source [REopt API](https://github.com/NatLabRockies/REopt_API), and the publicly-available [REopt Web Tool](https://reopt.nlr.gov/tool) calls the REopt API.
55

66
For more information about REopt.jl please see the Julia documentation:
7-
<!-- [![](https://img.shields.io/badge/docs-stable-blue.svg)](https://nrel.github.io/REopt.jl/stable) -->
8-
[![](https://img.shields.io/badge/docs-dev-blue.svg)](https://nrel.github.io/REopt.jl/dev)
7+
<!-- [![](https://img.shields.io/badge/docs-stable-blue.svg)](https://natlabrockies.github.io/REopt.jl/stable) -->
8+
[![](https://img.shields.io/badge/docs-dev-blue.svg)](https://natlabrockies.github.io/REopt.jl/dev)
99

1010

1111
## Quick Start
@@ -20,4 +20,4 @@ results = run_reopt(m, "pv_storage.json")
2020
```
2121
See the `test/scenarios` directory for examples of `scenario.json`.
2222

23-
For more details, including installation instructions, see the [documentation](https://nrel.github.io/REopt.jl/dev).
23+
For more details, including installation instructions, see the [documentation](https://natlabrockies.github.io/REopt.jl/dev).

docs/make.jl

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,5 +28,5 @@ makedocs(
2828
)
2929

3030
deploydocs(
31-
repo = "github.com/NREL/REopt.jl.git",
31+
repo = "github.com/NatLabRockies/REopt.jl.git",
3232
)

docs/src/index.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# REopt.jl
2-
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 optimizes the sizing and dispatch of integrated energy systems for buildings, campuses, communities, microgrids, and more. REopt identifies the cost-optimal mix of generation, storage, and heating and cooling technologies to meet cost savings, resilience, emissions reductions, and energy performance goals. The open-source REopt.jl code is available on GitHub: https://github.com/NREL/REopt.jl.
2+
REopt.jl is the core module of the [REopt® techno-economic decision support platform](https://www.nlr.gov/reopt/), developed by the National Laboratory of the Rockies (NLR). REopt optimizes the sizing and dispatch of integrated energy systems for buildings, campuses, communities, microgrids, and more. REopt identifies the cost-optimal mix of generation, storage, and heating and cooling technologies to meet cost savings, resilience, emissions reductions, and energy performance goals. The open-source REopt.jl code is available on GitHub: https://github.com/NatLabRockies/REopt.jl.
33

44
!!! note
5-
This REopt.jl package is used as the core model of the [REopt API](https://github.com/NREL/REopt_API) and the [REopt Web Tool](https://reopt.nrel.gov/tool). This package contains additional functionality and flexibility to run locally and customize.
5+
This REopt.jl package is used as the core model of the [REopt API](https://github.com/NatLabRockies/REopt_API) and the [REopt Web Tool](https://reopt.nlr.gov/tool). This package contains additional functionality and flexibility to run locally and customize.
66

77
## Installing
88
REopt evaluations for all system types except GHP (see below) can be performed using the following installation instructions from the package manager mode (`]`) of the Julia REPL:
@@ -22,13 +22,13 @@ ENV["NREL_DEVELOPER_EMAIL"]="your contact email"
2222
```
2323

2424
### Additional package loading for GHP
25-
GHP evaluations must load in the [`GhpGhx.jl`](https://github.com/NREL/GhpGhx.jl) package separately because it has a more [restrictive license](https://github.com/NREL/GhpGhx.jl/blob/main/LICENSE.md) and is not a registered Julia package.
25+
GHP evaluations must load in the [`GhpGhx.jl`](https://github.com/NatLabRockies/GhpGhx.jl) package separately because it has a more [restrictive license](https://github.com/NatLabRockies/GhpGhx.jl/blob/main/LICENSE.md) and is not a registered Julia package.
2626

2727
Install gcc via homebrew (if running on a Mac).
2828

2929
Add the GhpGhx.jl package to the project's dependencies from the package manager (`]`):
3030
```sh
31-
(active_env) pkg> add "https://github.com/NREL/GhpGhx.jl"
31+
(active_env) pkg> add "https://github.com/NatLabRockies/GhpGhx.jl"
3232
```
3333

3434
Load in the package from the script where `run_reopt()` is called:

docs/src/mpc/examples.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,4 +6,4 @@ using REopt, JuMP, Cbc
66
model = Model(Cbc.Optimizer)
77
results = run_mpc(model, "./test/scenarios/mpc.json")
88
```
9-
See [mpc.json](https://github.com/NREL/REopt/blob/master/test/scenarios/mpc.json) for details on the Scenario.
9+
See [mpc.json](https://github.com/NatLabRockies/REopt/blob/master/test/scenarios/mpc.json) for details on the Scenario.

docs/src/reopt/examples.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ m = Model(HiGHS.Optimizer)
1212
results = run_reopt(m, "pv_storage.json")
1313
```
1414

15-
The input file, in this case `pv_storage.json`, contains the set of user-defined inputs. For more on the inputs .json file, see the [REopt Inputs](@ref) section and find examples at [test/scenarios](https://github.com/NREL/REopt/blob/master/test/scenarios). For more examples of how to run REopt, see [`runtests.jl`](https://github.com/NREL/REopt.jl/blob/master/test/runtests.jl). To adjust settings such as optimality tolerance and logging, see more about relevant `Model()` arguments here: [open source solver setups](https://github.com/NREL/REopt_API/blob/master/julia_src/os_solvers.jl).
15+
The input file, in this case `pv_storage.json`, contains the set of user-defined inputs. For more on the inputs .json file, see the [REopt Inputs](@ref) section and find examples at [test/scenarios](https://github.com/NatLabRockies/REopt/blob/master/test/scenarios). For more examples of how to run REopt, see [`runtests.jl`](https://github.com/NatLabRockies/REopt.jl/blob/master/test/runtests.jl). To adjust settings such as optimality tolerance and logging, see more about relevant `Model()` arguments here: [open source solver setups](https://github.com/NatLabRockies/REopt_API/blob/master/julia_src/os_solvers.jl).
1616

1717
To compare the optimized case to a "Business-as-usual" case (with existing techs or no techs), you can run the [BAUScenario](@ref) scenario in parallel by providing two `JuMP.Model`s like so:
1818
```julia

src/REopt.jl

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# REopt®, Copyright (c) Alliance for Sustainable Energy, LLC. See also https://github.com/NREL/REopt.jl/blob/master/LICENSE.
1+
# REopt®, Copyright (c) Alliance for Energy Innovation, LLC. See also https://github.com/NatLabRockies/REopt.jl/blob/master/LICENSE.
22
module REopt
33

44
export

src/constraints/battery_degradation.jl

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# REopt®, Copyright (c) Alliance for Sustainable Energy, LLC. See also https://github.com/NREL/REopt.jl/blob/master/LICENSE.
1+
# REopt®, Copyright (c) Alliance for Energy Innovation, LLC. See also https://github.com/NatLabRockies/REopt.jl/blob/master/LICENSE.
22

33

44
function add_degradation_variables(m, p, segments)

src/constraints/chp_constraints.jl

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# REopt®, Copyright (c) Alliance for Sustainable Energy, LLC. See also https://github.com/NREL/REopt.jl/blob/master/LICENSE.
1+
# REopt®, Copyright (c) Alliance for Energy Innovation, LLC. See also https://github.com/NatLabRockies/REopt.jl/blob/master/LICENSE.
22
function add_chp_fuel_burn_constraints(m, p; _n="")
33
# Fuel burn slope and intercept
44
fuel_burn_slope, fuel_burn_intercept = fuel_slope_and_intercept(;

0 commit comments

Comments
 (0)