Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 10 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,11 +49,11 @@ Pkg.add([
````

Some other (optional) packages include
- [PowerGraphics](https://github.com/NREL-Sienna/PowerGraphics.jl)
- [PowerNetworkMatrices](https://github.com/NREL-Sienna/PowerNetworkMatrices.jl)
- [PowerFlows](https://github.com/NREL-Sienna/PowerFlows.jl)
- [HydroPowerSimulations](https://github.com/NREL-Sienna/HydroPowerSimulations.jl)
- [StorageSystemsSimulations](https://github.com/NREL-Sienna/StorageSystemsSimulations.jl)
- [PowerGraphics](https://github.com/NLR-Sienna/PowerGraphics.jl)
- [PowerNetworkMatrices](https://github.com/NLR-Sienna/PowerNetworkMatrices.jl)
- [PowerFlows](https://github.com/NLR-Sienna/PowerFlows.jl)
- [HydroPowerSimulations](https://github.com/NLR-Sienna/HydroPowerSimulations.jl)
- [StorageSystemsSimulations](https://github.com/NLR-Sienna/StorageSystemsSimulations.jl)

4. Now load the packages we'll need for now:

Expand Down Expand Up @@ -97,7 +97,7 @@ system
````

What are all these Types?
Take a look at the [Type Tree](https://nrel-sienna.github.io/PowerSystems.jl/stable/api/type_tree/).
Take a look at the [Type Tree](https://nlr-sienna.github.io/PowerSystems.jl/stable/api/type_tree/).

## Let's explore and retrieve data

Expand Down Expand Up @@ -130,7 +130,7 @@ get_units_base(system)

Getters and setters handle per-unitization for you, but different per-unitization options trip up new users!
When in doubt, switch your system units base and spotcheck your data with different bases to make sure you're confident.
See **Changing System Per-Unit Settings** in [Create and Explore a Power System](https://nrel-sienna.github.io/PowerSystems.jl/stable/tutorials/generated_creating_system/).
See **Changing System Per-Unit Settings** in [Create and Explore a Power System](https://nlr-sienna.github.io/PowerSystems.jl/stable/tutorials/generated_creating_system/).

13. Change the settings to device base (per-unitized by `base_power` value):

Expand Down Expand Up @@ -280,7 +280,7 @@ template = template_unit_commitment()
````

How do you learn more about the different formulations?
See the [Formulation Library](https://nrel-sienna.github.io/PowerSimulations.jl/stable/formulation_library/Introduction/).
See the [Formulation Library](https://nlr-sienna.github.io/PowerSimulations.jl/stable/formulation_library/Introduction/).

32. Apply that template to our data to make a complete model, with both data and equations:

Expand Down Expand Up @@ -365,7 +365,7 @@ set_device_model!(template, ThermalStandard, ThermalStandardUnitCommitment)
````

You can see the formulations options in the documentation for
[ThermalGen](https://nrel-sienna.github.io/PowerSimulations.jl/stable/formulation_library/ThermalGen/).
[ThermalGen](https://nlr-sienna.github.io/PowerSimulations.jl/stable/formulation_library/ThermalGen/).

42. We've changed our template, so we need to re-build the DecisionModels within our simulation, which
includes a copy of the template:
Expand Down Expand Up @@ -473,7 +473,7 @@ timeless_computations = [PA.calc_sum_objective_value, PA.calc_sum_solve_time, PA
timeless_names = ["Objective Value", "Solve Time", "Memory Allocated"];
````

For more, see PowerAnalytics' [Built-In Metrics](https://nrel-sienna.github.io/PowerAnalytics.jl/stable/reference/public/#Built-in-Metrics).
For more, see PowerAnalytics' [Built-In Metrics](https://nlr-sienna.github.io/PowerAnalytics.jl/stable/reference/public/#Built-in-Metrics).

52. We'll also make selectors, which help us calculate our metrics across whichever dimensions and/or groupings
are of interest:
Expand Down
12 changes: 6 additions & 6 deletions docs/make.jl
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,10 @@ using DocumenterInterLinks


links = InterLinks(
"InfrastructureSystems" => "https://nrel-sienna.github.io/InfrastructureSystems.jl/stable/",
"PowerSystems" => "https://nrel-sienna.github.io/PowerSystems.jl/stable/",
"PowerSimulations" => "https://nrel-sienna.github.io/PowerSimulations.jl/stable/",
"PowerAnalytics" => "https://nrel-sienna.github.io/PowerAnalytics.jl/stable/",
"InfrastructureSystems" => "https://nlr-sienna.github.io/InfrastructureSystems.jl/stable/",
"PowerSystems" => "https://nlr-sienna.github.io/PowerSystems.jl/stable/",
"PowerSimulations" => "https://nlr-sienna.github.io/PowerSimulations.jl/stable/",
"PowerAnalytics" => "https://nlr-sienna.github.io/PowerAnalytics.jl/stable/",
)

# Explicitly defined fallbacks for external docstrings that fail to resolve
Expand Down Expand Up @@ -36,15 +36,15 @@ makedocs(
format = Documenter.HTML(
prettyurls = haskey(ENV, "GITHUB_ACTIONS"),
size_threshold = nothing,),
sitename = "github.com/NREL-Sienna/SiennaOps-Training",
sitename = "github.com/NLR-Sienna/SiennaOps-Training",
authors = "Freddy Mercury",
pages = Any[p for p in pages],
draft = false,
plugins = [links, fallbacks],
)

deploydocs(
repo="github.com/NREL-Sienna/SiennaOps-Training",
repo="github.com/NLR-Sienna/SiennaOps-Training",
target="build",
branch="gh-pages",
devbranch="main",
Expand Down
2 changes: 1 addition & 1 deletion docs/make_tutorials.jl
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ end
# This ensures that links generated in notebooks point to the correct
# location for stable, dev, and preview builds.
function _compute_docs_base_url()
base = "https://nrel-sienna.github.io/SiennaTemplate.jl"
base = "https://nlr-sienna.github.io/SiennaTemplate.jl"

current_version = get(ENV, "DOCUMENTER_CURRENT_VERSION", "")

Expand Down
12 changes: 6 additions & 6 deletions docs/src/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,13 +14,13 @@ copy-pastable code for guided training sessions.
This work is part of the National Laboratory of the Rockies (formerly known as NREL)'s
[Sienna ecosystem](https://www.nlr.gov/analysis/sienna.html), an open source framework for
scheduling problems and dynamic simulations for power systems. The Sienna ecosystem can be
[found on github](https://github.com/NREL-Sienna/Sienna). It contains three applications:
[found on github](https://github.com/NLR-Sienna/Sienna). It contains three applications:

- [Sienna\Data](https://nrel-sienna.github.io/Sienna/pages/applications/sienna_data.html) enables
- [Sienna\Data](https://nlr-sienna.github.io/Sienna/pages/applications/sienna_data.html) enables
efficient data input, analysis, and transformation
- [Sienna\Ops](https://nrel-sienna.github.io/Sienna/pages/applications/sienna_ops.html) enables
- [Sienna\Ops](https://nlr-sienna.github.io/Sienna/pages/applications/sienna_ops.html) enables
enables system scheduling simulations by formulating and solving optimization problems
- [Sienna\Dyn](https://nrel-sienna.github.io/Sienna/pages/applications/sienna_dyn.html) enables
- [Sienna\Dyn](https://nlr-sienna.github.io/Sienna/pages/applications/sienna_dyn.html) enables
system transient analysis including small signal stability and full system dynamic
simulations

Expand All @@ -29,6 +29,6 @@ programming language.

## Installation and Quick Links

- [Sienna installation page](https://nrel-sienna.github.io/Sienna/SiennaDocs/docs/build/how-to/install/):
- [Sienna installation page](https://nlr-sienna.github.io/Sienna/SiennaDocs/docs/build/how-to/install/):
Instructions to install other Sienna packages
- [Sienna Documentation Hub](https://nrel-sienna.github.io/Sienna/SiennaDocs/docs/build/index.html):
- [Sienna Documentation Hub](https://nlr-sienna.github.io/Sienna/SiennaDocs/docs/build/index.html):
8 changes: 4 additions & 4 deletions docs/src/reference/developer_guidelines.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
# Developer Guidelines

In order to contribute to `SiennaTemplate.jl` repository please read the following sections of
[`InfrastructureSystems.jl`](https://github.com/NREL-Sienna/InfrastructureSystems.jl)
[`InfrastructureSystems.jl`](https://github.com/NLR-Sienna/InfrastructureSystems.jl)
documentation in detail:

1. [Style Guide](https://nrel-sienna.github.io/InfrastructureSystems.jl/stable/style/)
2. [Documentation Best Practices](https://nrel-sienna.github.io/InfrastructureSystems.jl/stable/docs_best_practices/explanation/)
3. [Contributing Guidelines](https://github.com/NREL-Sienna/SiennaTemplate.jl/blob/main/CONTRIBUTING.md)
1. [Style Guide](https://nlr-sienna.github.io/InfrastructureSystems.jl/stable/style/)
2. [Documentation Best Practices](https://nlr-sienna.github.io/InfrastructureSystems.jl/stable/docs_best_practices/explanation/)
3. [Contributing Guidelines](https://github.com/NLR-Sienna/SiennaTemplate.jl/blob/main/CONTRIBUTING.md)

Pull requests are always welcome to fix bugs or add additional modeling capabilities.

Expand Down
20 changes: 10 additions & 10 deletions docs/src/tutorials/SiennaOps-Training.jl
Original file line number Diff line number Diff line change
Expand Up @@ -37,11 +37,11 @@ Pkg.add([
]);

# Some other (optional) packages include
# - [PowerGraphics](https://github.com/NREL-Sienna/PowerGraphics.jl)
# - [PowerNetworkMatrices](https://github.com/NREL-Sienna/PowerNetworkMatrices.jl)
# - [PowerFlows](https://github.com/NREL-Sienna/PowerFlows.jl)
# - [HydroPowerSimulations](https://github.com/NREL-Sienna/HydroPowerSimulations.jl)
# - [StorageSystemsSimulations](https://github.com/NREL-Sienna/StorageSystemsSimulations.jl)
# - [PowerGraphics](https://github.com/NLR-Sienna/PowerGraphics.jl)
# - [PowerNetworkMatrices](https://github.com/NLR-Sienna/PowerNetworkMatrices.jl)
# - [PowerFlows](https://github.com/NLR-Sienna/PowerFlows.jl)
# - [HydroPowerSimulations](https://github.com/NLR-Sienna/HydroPowerSimulations.jl)
# - [StorageSystemsSimulations](https://github.com/NLR-Sienna/StorageSystemsSimulations.jl)


# 4. Now load the packages we'll need for now:
Expand Down Expand Up @@ -71,7 +71,7 @@ system = build_system(PSISystems, "modified_RTS_GMLC_DA_sys");
system

# What are all these Types?
# Take a look at the [Type Tree](https://nrel-sienna.github.io/PowerSystems.jl/stable/api/type_tree/).
# Take a look at the [Type Tree](https://nlr-sienna.github.io/PowerSystems.jl/stable/api/type_tree/).

# ## Let's explore and retrieve data

Expand All @@ -92,7 +92,7 @@ get_units_base(system)

# Getters and setters handle per-unitization for you, but different per-unitization options trip up new users!
# When in doubt, switch your system units base and spotcheck your data with different bases to make sure you're confident.
# See **Changing System Per-Unit Settings** in [Create and Explore a Power System](https://nrel-sienna.github.io/PowerSystems.jl/stable/tutorials/generated_creating_system/).
# See **Changing System Per-Unit Settings** in [Create and Explore a Power System](https://nlr-sienna.github.io/PowerSystems.jl/stable/tutorials/generated_creating_system/).

# 13. Change the settings to device base (per-unitized by `base_power` value):
set_units_base_system!(system, "DEVICE_BASE")
Expand Down Expand Up @@ -186,7 +186,7 @@ solver = optimizer_with_attributes(
template = template_unit_commitment()

# How do you learn more about the different formulations?
# See the [Formulation Library](https://nrel-sienna.github.io/PowerSimulations.jl/stable/formulation_library/Introduction/).
# See the [Formulation Library](https://nlr-sienna.github.io/PowerSimulations.jl/stable/formulation_library/Introduction/).

# 32. Apply that template to our data to make a complete model, with both data and equations:
models = SimulationModels(
Expand Down Expand Up @@ -245,7 +245,7 @@ total_costs_prod = sum(costs[:, :value])
set_device_model!(template, ThermalStandard, ThermalStandardUnitCommitment)

# You can see the formulations options in the documentation for
# [ThermalGen](https://nrel-sienna.github.io/PowerSimulations.jl/stable/formulation_library/ThermalGen/).
# [ThermalGen](https://nlr-sienna.github.io/PowerSimulations.jl/stable/formulation_library/ThermalGen/).

# 42. We've changed our template, so we need to re-build the DecisionModels within our simulation, which
# includes a copy of the template:
Expand Down Expand Up @@ -323,7 +323,7 @@ PA = PowerAnalytics
timeless_computations = [PA.calc_sum_objective_value, PA.calc_sum_solve_time, PA.calc_sum_bytes_alloc]
timeless_names = ["Objective Value", "Solve Time", "Memory Allocated"];

# For more, see PowerAnalytics' [Built-In Metrics](https://nrel-sienna.github.io/PowerAnalytics.jl/stable/reference/public/#Built-in-Metrics).
# For more, see PowerAnalytics' [Built-In Metrics](https://nlr-sienna.github.io/PowerAnalytics.jl/stable/reference/public/#Built-in-Metrics).

# 52. We'll also make selectors, which help us calculate our metrics across whichever dimensions and/or groupings
# are of interest:
Expand Down