-
Notifications
You must be signed in to change notification settings - Fork 100
Jb/documentation updates #1635
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
base: main
Are you sure you want to change the base?
Jb/documentation updates #1635
Changes from 38 commits
bcba6ba
828910d
db59c76
6ee4e64
5ae3d74
2e3b27b
cede0fb
386116e
0d81648
f921449
0224c49
499baef
d116d78
ce0fc4d
a65d888
73d451d
9e049ca
d8e579f
08f79af
3d3f9a6
4449319
ecd69fa
6844b0f
4d13017
a344bbe
08c2d07
35e8fbd
b228162
ded0513
d907136
6c2ab2c
cfde49c
ade8efe
0dcd08b
907f72a
286452b
62cae42
6e722c0
a209d03
df51ede
60876fd
0fad077
5b521ae
31b8e66
8e3a718
6bf5838
2ae0447
e9ce9db
be6a930
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -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", | ||
|
|
@@ -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", | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe 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[], | ||
|
|
||
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -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) | | ||||||
|
||||||
| | `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) | |
There was a problem hiding this comment.
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
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| 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 | ||
|
|
||
|
|
@@ -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 | ||
|
|
@@ -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 | ||
|
|
@@ -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 | ||
|
|
@@ -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/) | ||
|
|
@@ -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 | ||
|
|
@@ -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 | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe 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 | ||
|
|
@@ -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 | ||
|
|
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -10,7 +10,7 @@ Pages = ["PowerSystems.jl", | |
| "injection.jl", | ||
| "devices.jl", | ||
| "loads.jl", | ||
| "supplemental_constructors", | ||
| "supplemental_constructors.jl", | ||
| "generation.jl", | ||
| "reserves.jl", | ||
| "storage.jl", | ||
|
|
@@ -20,7 +20,6 @@ Pages = ["PowerSystems.jl", | |
| "static_models.jl", | ||
| "subsystems.jl", | ||
| "static_injection_subsystem.jl", | ||
| "dynamic_models.jl", | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Why is this removed?
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe 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" | ||
|
|
||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
delete this file