Skip to content
Open
Show file tree
Hide file tree
Changes from 38 commits
Commits
Show all changes
49 commits
Select commit Hold shift + click to select a range
bcba6ba
Additional changes to supplemental attributes and initial changes to …
Feb 17, 2026
828910d
Update figure size
Feb 18, 2026
db59c76
Add to glossary and fix spelling mistakes
Feb 19, 2026
6ee4e64
Additional spelling edits
Feb 19, 2026
5ae3d74
Changed accessor to getter functions
Feb 23, 2026
2e3b27b
Supplemental attribute changes
Feb 23, 2026
cede0fb
First pass at edits to system
Feb 23, 2026
386116e
Finish system explanation edits
Feb 24, 2026
0d81648
Ran compilation and fixed mostly reference issues
Feb 24, 2026
f921449
Edits to Type Structure Explanation
Mar 2, 2026
0224c49
Edits to buses_type_explanation.md
Mar 2, 2026
499baef
Edits to Power Concepts
Mar 2, 2026
d116d78
Edits to conforming and non-conforming loads
Mar 2, 2026
ce0fc4d
Address requested edits
Mar 3, 2026
a65d888
Transformer per unit transformations and per-unit conventions edits
Mar 3, 2026
73d451d
time_series edits
Mar 3, 2026
9e049ca
Dynamic devices edits
Mar 3, 2026
d8e579f
Tag out @id tags in tutorials
Mar 3, 2026
08f79af
Convert '''julia blocks to '''repl blocks
Mar 3, 2026
3d3f9a6
Implement best practices for hyperlinks
Mar 5, 2026
4449319
Concrete vs abstract supplemental attributes
Mar 10, 2026
ecd69fa
Add info about broadcast functions
Mar 10, 2026
6844b0f
Glossary edits for plant_attributes
Mar 10, 2026
4d13017
Add more getter functions
Mar 10, 2026
a344bbe
Docstring edits
Mar 17, 2026
08c2d07
More docstring edits
Mar 19, 2026
35e8fbd
More docstring edits
Mar 19, 2026
b228162
Even more docstring edits
Mar 23, 2026
ded0513
Address enum issues in #1611
Mar 23, 2026
d907136
Doc string edits to PowerSystems and compile
Mar 24, 2026
6c2ab2c
Compilation edits
jbrossman Apr 15, 2026
cfde49c
Merge branch 'main' into jb/documentation-updates
jbrossman Apr 15, 2026
ade8efe
Fixing issues from compilation
jbrossman Apr 15, 2026
0dcd08b
Merge branch 'main' into jb/documentation-updates
jbrossman Apr 15, 2026
907f72a
Suggested change from copilot to prevent failure
jbrossman Apr 15, 2026
286452b
Remove line from transform_single_time_series
jbrossman Apr 15, 2026
62cae42
Issues with previous build
jbrossman Apr 16, 2026
6e722c0
Run tests locally and recompile
jbrossman Apr 16, 2026
a209d03
Merge branch 'main' into jb/documentation-updates
jbrossman Apr 21, 2026
df51ede
Initial changes, does not include docstring edits
jbrossman Apr 21, 2026
60876fd
C level docstring effort
jbrossman Apr 22, 2026
0fad077
Merging main into personal branch
jbrossman Apr 22, 2026
5b521ae
Documentation corrections
jbrossman Apr 28, 2026
31b8e66
Fixing compilation errors
jbrossman Apr 29, 2026
8e3a718
Final compilation edits
jbrossman Apr 30, 2026
6bf5838
Bring back a keyword argument
jbrossman Apr 30, 2026
2ae0447
Merge branch 'main' into jb/documentation-updates
jbrossman May 1, 2026
e9ce9db
Delete requested files
jbrossman May 1, 2026
be6a930
Merge branch 'jb/documentation-updates' of https://github.com/Sienna-…
jbrossman May 1, 2026
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
Binary file added docs/build.zip
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

delete this file

Binary file not shown.
12 changes: 9 additions & 3 deletions docs/make.jl
Original file line number Diff line number Diff line change
Expand Up @@ -42,8 +42,15 @@ pages = OrderedDict(
"Save and read data with a JSON" => "how_to/serialize_data.md",
],
"...add a component using natural units (MW)" => "how_to/add_component_natural_units.md",
"...read component values in different unit systems" => "how_to/convert_unit_systems.md",
"...convert transformer impedances between per-unit bases" => "how_to/convert_transformer_impedance.md",
"...use subsystems" => "how_to/use_subsystems.md",
"...use context managers for bulk operations" => "how_to/use_context_managers.md",
"...add additional data to a component" => "how_to/adding_additional_fields.md",
"...add additional data to a component" => Any[
"Add Supplemental Attributes to a System" => "how_to/add_supplemental_attributes.md",
"Use Supplemental Attributes" => "how_to/use_supplemental_attributes.md",
"Add additional fields to a component" => "how_to/adding_additional_fields.md",
],
"...add time-series data" => Any[
"Parse time series data from .csv files" => "how_to/parse_ts_from_csvs.md",
"Improve performance with time series data" => "how_to/improve_ts_performance.md",
Expand Down Expand Up @@ -72,10 +79,9 @@ pages = OrderedDict(
"explanation/per_unit.md",
"explanation/power_concepts.md",
"explanation/conforming_and_non_conforming_loads.md",
"explanation/transformer_per_unit_models.md",
"explanation/time_series.md",
"explanation/dynamic_data.md",
"explanation/supplemental_attributes.md",
"explanation/supplemental_attributes_2.md",
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Rename the new file back to supplemental_attributes.md

"explanation/plant_attributes.md",
],
"Model Library" => Any[],
Expand Down
4 changes: 2 additions & 2 deletions docs/src/api/enumerated_types.md
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,7 @@ EIA Annual Energy Review. `ThermalFuels` has the options:
| `BLACK_LIQUOR` | BLQ | Black Liquor |
| `WOOD_WASTE_LIQUIDS` | WDL | Wood Waste Liquids excluding Black Liquor (includes red liquor, sludge wood, spent sulfite liquor, and other wood-based liquids) |
| `LANDFILL_GAS` | LFG | Landfill Gas |
| `OTHEHR_BIOMASS_GAS` | OBG | Other Biomass Gas (includes digester gas, methane, and other biomass gasses) |
| `OTHER_BIOMASS_GAS` | OBG | Other Biomass Gas (includes digester gas, methane, and other biomass gasses) |
Copy link

Copilot AI Apr 16, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The docs list the fuel enum value as OTHER_BIOMASS_GAS, but the actual enum in src/definitions.jl is spelled OTHEHR_BIOMASS_GAS. This mismatch will confuse users and example code will fail if they follow the docs. Either update the enum name in code (and provide a deprecation alias if needed) or keep the docs aligned with the current exported name.

Suggested change
| `OTHER_BIOMASS_GAS` | OBG | Other Biomass Gas (includes digester gas, methane, and other biomass gasses) |
| `OTHEHR_BIOMASS_GAS` | OBG | Other Biomass Gas (includes digester gas, methane, and other biomass gasses) |

Copilot uses AI. Check for mistakes.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Update src/definitions.jl and any other uses and note the breaking change in PR comment

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

| `NUCLEAR` | NUC | Nuclear Uranium, Plutonium, Thorium |
| `WASTE_HEAT` | WH | Waste heat not directly attributed to a fuel source |
| `TIREDERIVED_FUEL` | TDF | Tire-derived Fuels |
Expand Down Expand Up @@ -159,7 +159,7 @@ the different alternatives of `ReservoirDataType`, which has the options:
| `CONFORMING` | Conforming load |
| `UNDEFINED` | Undefined or unknown whether load is conforming or non-conforming |

## [Tranformer Control Objectives](@id xtf_crtl)
## [Transformer Control Objectives](@id xtf_crtl)

`TransformerControlObjective` is used to select the control objective for a transformer's
tap changer, which can be used to determine the tap position during power flow calculations.
Expand Down
63 changes: 49 additions & 14 deletions docs/src/api/glossary.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Glossary and Acronyms

[A](@ref) | [D](@ref) | [E](@ref) | [F](@ref) | [H](@ref) | [I](@ref) | [O](@ref) | [P](@ref) | [R](@ref) |
[S](@ref) | [V](@ref) | [W](@ref) | [Z](@ref)
[A](@ref) | [C](@ref) | [D](@ref) | [E](@ref) | [F](@ref) | [H](@ref) | [I](@ref) | [O](@ref) | [P](@ref) | [R](@ref) |
[S](@ref) | [U](@ref) | [V](@ref) | [W](@ref) | [Z](@ref)

### A

Expand All @@ -13,25 +13,47 @@

- *AVR*: Automatic Voltage Regulator

### C

- *CA*: EIA prime mover code for the steam turbine (combined cycle steam) portion of a combined cycle plant

- *CAISO*: California Independent System Operator

- *CC*: EIA prime mover code for combined cycle units

- *CT*: Combustion Turbine

### D

- *DC*: Direct current

- *DERA1*:

- *Deterministic*: mathematical model in which the outcomes are precisely determined through known relationships among states and events. For contrast, see the definition of [Probabilistic](@ref P).

- *Dynamic*: Refers to data and simulations for power system transient simulations using differential
equations. Common examples include signal stability analysis to verify the power system will
maintain stability in the few seconds following an unexpected fault or generator trip. For contrast,
see the definition for [Static](@ref S) data.

### E

- *EIA*: U.S. Energy Information Administration

- *EIM*: Energy Imbalance Market

- *EMF*: Electromotive force

- *ESAC*: IEEE Type AC Excitation System model

- *ESDC*: IEEE Type DC Excitation System model

- *EXAC*: IEEE Type AC Excitation System (modified) model

- *EXPIC*: Proportional/Integral Excitation System from PSS/E

- *EXST*: IEEE Type ST (Static) Excitation System model

- *EX4VSA*: IEEE Excitation System for Voltage Security Assessment with Over-Excitation Limits.

### F
Expand All @@ -53,6 +75,8 @@
forecast included the next day plus a 24-hour lookahead window, the horizon would be
`Dates.Hour(48)` or `Dates.Day(2)`. See the article on [`Time Series Data`](@ref ts_data).

- *HRSG*: Heat Recovery Steam Generator

- *HVDC*: High-voltage DC

### I
Expand Down Expand Up @@ -83,6 +107,8 @@

### P

- *PCC*: Point of Common Coupling. The point where a generator or plant connects to the grid.

- *PLL*: Phase-locked loop

- *PSS*: Power System Stabilizer
Expand All @@ -91,6 +117,8 @@

- *PPA*: Power purchase agreement

- *Probabilistic*: mathematical model in which the outcomes represent random phenomenon. For contrast, see the definition of [Deterministic](@ref D).

- *PSI*: [`PowerSimulations.jl`](https://nrel-sienna.github.io/PowerSimulations.jl/latest/)

- *PSID*: [`PowerSimulationsDynamics.jl`](https://nrel-sienna.github.io/PowerSimulationsDynamics.jl/stable/)
Expand All @@ -101,6 +129,8 @@

- *pu* or *p.u.*: Per-unit

- *PWM*: Pulse-width modulation. A switching technique used in power converters to synthesize a desired AC output voltage by rapidly toggling switches at a high frequency.

### R

- *REECB1*: Renewable Energy Electric Controller Type B1
Expand All @@ -117,22 +147,25 @@

- *SIL*: Surge impedance loading

- *ST*: Steam Turbine

- *States*: Correspond to the set of inputs, outputs or variables, that evolve dynamically in
[`PowerSimulationsDynamics.jl`](https://nrel-sienna.github.io/PowerSimulationsDynamics.jl/stable/),
commonly via a differential-algebraic system of equations. In `PowerSystems.jl`, a component
associated to a `DynamicInjector` (for example an AVR) specifies the set of states that specific
component requires to be modeled accurately.

- *Static*: Typically refers to steady state data or models where the power system
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not a big deal, but we generally try to stay within a 92/93 character line width where applicable (doesn't always work, for some required file formats), which is JuliaFormatter standard for readability. Don't bother changing, but leave line widths as they are if you find them that way

and each of its components are assumed to be operating at a steady state equilibrium point. This
includes both power flow data for a single time point simulation as well as quasi-static time
series data and models, where the power system is at an equilibrium point at each time step.
Static data can be used as the input to single time point power flow models and production
cost models with, for example, 5-minute, 15-minute, or 1-hour [Resolution](@ref R).
For contrast, see the definition for [Dynamic](@ref D) data.
[`PowerSimulationsDynamics.jl`](https://nrel-sienna.github.io/PowerSimulationsDynamics.jl/stable/), commonly via a differential-algebraic system of equations. In `PowerSystems.jl`, a component associated to a `DynamicInjector` (for example an AVR) specifies the set of states that specific component requires to be modeled accurately.

- *Static*: Typically refers to steady state data or models where the power system and each of its components are assumed to be operating at a steady state equilibrium point. This includes both power flow data for a single time point simulation as well as quasi-static time series data and models, where the power system is at an equilibrium point at each time step. Static data can be used as the input to single time point power flow models and production cost models with, for example, 5-minute, 15-minute, or 1-hour [Resolution](@ref R). For contrast, see the definition for [Dynamic](@ref D) data.

- *STAB*: Speed Sensitive Stabilizing PSS Model

- *Struct*: A composite data type in Julia that can store multiple values in a single object. See the Julia documentation on [`struct`](https://docs.julialang.org/en/v1/base/base/#struct)
and [Composite Types](https://docs.julialang.org/en/v1/manual/types/#Composite-Types).

- *SVM*: Space vector modulation. A control algorithm for three-phase inverters that represents the desired output voltage as a vector in the complex plane and selects switching states to approximate it, achieving lower harmonic distortion than basic [PWM](@ref D).

### U

- *UUID*: Universally Unique Identifier. A 128-bit identifier formatted as a 32-character
hexadecimal string (e.g. `5f180c4c-cd81-4b80-8c60-627c28aef8b0`).

### V

- *VSCLine*: Voltage-Source Converter HVDC Line
Expand All @@ -141,6 +174,8 @@

### W

- *WECC*: Western Electricity Coordinating Council

- *Window*: A forecast window is one forecast run that starts at one [initial time](@ref I)
and extends through the forecast [horizon](@ref H). Typically, a forecast data set
contains multiple forecast windows, with sequential initial times. For example, a
Expand Down
3 changes: 1 addition & 2 deletions docs/src/api/public.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Pages = ["PowerSystems.jl",
"injection.jl",
"devices.jl",
"loads.jl",
"supplemental_constructors",
"supplemental_constructors.jl",
"generation.jl",
"reserves.jl",
"storage.jl",
Expand All @@ -20,7 +20,6 @@ Pages = ["PowerSystems.jl",
"static_models.jl",
"subsystems.jl",
"static_injection_subsystem.jl",
"dynamic_models.jl",
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why is this removed?

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It is listed twice. See line 19.

"operational_cost.jl",
"cost_function_timeseries.jl",
"definitions.jl"
Expand Down
2 changes: 1 addition & 1 deletion docs/src/api/static_injection_subtypes.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ This document summarizes the similarities and differences between [`StaticInject

² EnergyReservoirStorage uses `input_active_power_limits` and `output_active_power_limits` instead

Here, "`MinMax` (optional)" means `Union{MinMax, Nothing}`, with `nothing` repesenting "no limits" and being the default.
Here, "`MinMax` (optional)" means `Union{MinMax, Nothing}`, with `nothing` representing "no limits" and being the default.

⊕ = Split across 3 ZIP fields: `*_constant_*`, `*_impedance_*`, `*_current_*`

Expand Down
Loading
Loading