Skip to content

Commit 0a75d2d

Browse files
authored
Merge branch 'NREL-Sienna:main' into bugfix/check_empty_not_nothing
2 parents 6d4e41f + 4e270f3 commit 0a75d2d

Some content is hidden

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

67 files changed

+2269
-1649
lines changed

docs/Project.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,6 @@ TypeTree = "04da0e3b-1cad-4b2c-a963-fc1602baf1af"
1515

1616
[compat]
1717
CSV = "~0.10"
18-
Documenter = "^0.27"
18+
Documenter = "^1.5"
1919
InfrastructureSystems = "2"
2020
julia = "^1.6"

docs/make.jl

Lines changed: 24 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -12,22 +12,24 @@ pages = OrderedDict(
1212
"Tutorials" => Any[
1313
"Create and Explore a Power `System`" => "tutorials/creating_system.md",
1414
"Working with Time Series" => "tutorials/working_with_time_series.md",
15-
"Adding dynamic devices" => "tutorials/add_dynamic_device.md",
15+
"Adding Data for Dynamic Simulations" => "tutorials/add_dynamic_data.md",
1616
],
1717
"How to..." => Any[
1818
"...install PowerSystems.jl" => "how_to/install.md",
1919
"...load a `system` from `PowerSystemCaseBuilder`" => "how_to/powersystembuilder.md",
20-
"...parse data from Matpower, PSSE, or CSV files" => "how_to/parsing.md",
21-
"...add time series data from CSVs" => "how_to/add_ts_from_csvs.md",
22-
"...customize the tabular data parser" => "how_to/extend_tabular_parsing.md",
20+
"...parse data from MATPOWER or PSS/e files" => "how_to/parse_matpower_psse.md",
21+
"...parse PSS/e dynamic data" => "how_to/parse_dynamic_data.md",
22+
"...parse tabular data from .csv files" => "how_to/parse_tabular_data.md",
23+
"...parse time series data from .csv files" => "how_to/parse_ts_from_csvs.md",
24+
"...add a component using natural units (MW)" => "how_to/add_component_natural_units.md",
2325
"...get all the buses in a system" => "how_to/get_buses.md",
2426
"...get the available generators in a system" => "how_to/get_available_generators.md",
2527
"...add an Operating Cost" => "how_to/add_cost_curve.md",
2628
"...add a market bid" => "how_to/market_bid_cost.md",
2729
"...add additional data to a component" => "how_to/adding_additional_fields.md",
28-
"...add a new Type" => "how_to/add_new_types.md",
30+
"...customize or add a new Type" => "how_to/add_new_types.md",
2931
"...improve performance with time series data" => "how_to/improve_ts_performance.md",
30-
"...serialize data to a JSON" => "how_to/serialize_data.md",
32+
"...write and read data with a JSON" => "how_to/serialize_data.md",
3133
"...reduce REPL printing" => "how_to/reduce_repl_printing.md",
3234
"...migrate from version 3.0 to 4.0" => "how_to/migrating_to_psy4.md"
3335
],
@@ -37,18 +39,18 @@ pages = OrderedDict(
3739
"explanation/type_structure.md",
3840
"explanation/per_unit.md",
3941
"explanation/time_series.md",
40-
"explanation/example_dynamic_data.md",
42+
"explanation/dynamic_data.md",
4143
],
4244
"Model Library" => Any[],
4345
"Reference" =>
4446
Any["Public API" => "api/public.md",
45-
"Internal API Reference" => "api/internal.md",
4647
"Glossary and Acronyms" => "api/glossary.md",
4748
"Type Hierarchy" => "api/type_tree.md",
4849
"`ValueCurve` Options" => "api/valuecurve_options.md",
4950
"Specifying the category of..." => "api/enumerated_types.md",
50-
"Developer Guidelines" => "api/developer_guidelines.md",
51-
"Citation" => "api/citation.md"
51+
"Citation" => "api/citation.md",
52+
"Developers" => ["Developer Guidelines" => "api/developer_guidelines.md",
53+
"Internals" => "api/internal.md"]
5254
]
5355

5456

@@ -59,14 +61,17 @@ pages["Model Library"] = make_model_library(
5961
Topology,
6062
StaticInjection,
6163
Service,
62-
Branch
64+
Branch,
65+
DynamicInjection,
6366
],
6467
exceptions = [PSY.DynamicComponent,
6568
PSY.ActivePowerControl,
6669
PSY.ReactivePowerControl,
6770
PSY.DynamicBranch,
6871
PSY.HybridSystem,
69-
PSY.OperationalCost
72+
PSY.OperationalCost,
73+
PSY.DynamicInverter,
74+
PSY.DynamicGenerator,
7075
],
7176
manual_additions =
7277
Dict("Service" => ["Reserves" => "model_library/reserves.md"],
@@ -81,8 +86,6 @@ pages["Model Library"] = make_model_library(
8186
"StorageCost" =>"model_library/storage_cost.md",
8287
"LoadCost" =>"model_library/load_cost.md",
8388
"MarketBidCost" =>"model_library/market_bid_cost.md"],
84-
"Cost Curves" => ["Variable Cost Curves" => "model_library/cost_curves.md",
85-
"Value Curves" => "model_library/value_curves.md"]
8689
)
8790
)
8891

@@ -128,11 +131,14 @@ for (section, folder) in folders
128131
end
129132

130133
makedocs(
131-
modules = [PowerSystems, InfrastructureSystems],
132-
format = Documenter.HTML(prettyurls = haskey(ENV, "GITHUB_ACTIONS"),),
134+
modules = [PowerSystems],
135+
format = Documenter.HTML(
136+
prettyurls = haskey(ENV, "GITHUB_ACTIONS"),
137+
size_threshold = nothing,),
133138
sitename = "PowerSystems.jl",
134-
authors = "Jose Daniel Lara, Daniel Thom, Kate Doubleday, and Clayton Barrows",
135-
pages = Any[p for p in pages]
139+
authors = "Jose Daniel Lara, Daniel Thom, Kate Doubleday, Rodrigo Henriquez-Auba, and Clayton Barrows",
140+
pages = Any[p for p in pages],
141+
draft = false,
136142
)
137143

138144
deploydocs(

docs/src/api/citation.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,6 @@ author = {José Daniel Lara and Clayton Barrows and Daniel Thom and Dheepak Kris
1717
keywords = {Power Systems, Julia, Energy},
1818
```
1919

20-
------------
21-
PowerSystems has been developed as part of the [Sienna modeling framework](https://www.nrel.gov/analysis/sienna.html)
20+
PowerSystems has been developed as part of the [Sienna platform](https://www.nrel.gov/analysis/sienna.html)
2221
by the U.S. Department of Energy's National Renewable Energy Laboratory
2322
([NREL](https://www.nrel.gov/)).

docs/src/api/developer_guidelines.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,8 @@ In order to contribute to `PowerSystems.jl` repository please read the following
44
[`InfrastructureSystems.jl`](https://github.com/NREL-Sienna/InfrastructureSystems.jl)
55
documentation in detail:
66

7-
1. [Style Guide](https://nrel-sienna.github.io/InfrastructureSystems.jl/stable/style/)
8-
2. [Contributing Guidelines](https://github.com/NREL-Sienna/PowerSystems.jl/blob/main/CONTRIBUTING.md)
7+
1. [Style Guide](https://nrel-sienna.github.io/InfrastructureSystems.jl/stable/style/)
8+
2. [Contributing Guidelines](https://github.com/NREL-Sienna/PowerSystems.jl/blob/main/CONTRIBUTING.md)
99

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

docs/src/api/enumerated_types.md

Lines changed: 71 additions & 71 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
1-
21
# Specifying the type of...
32

43
Some fields in PowerSystems.jl are specified with an option from a pre-defined list
5-
(Specified with [`IS.scoped_enums`](https://nrel-sienna.github.io/InfrastructureSystems.jl/stable/InfrastructureSystems/#InfrastructureSystems.@scoped_enum-Tuple{Any,%20Vararg{Any,%20N}%20where%20N})).
4+
(Specified with [`IS.scoped_enums`](https://nrel-sienna.github.io/InfrastructureSystems.jl/stable/InfrastructureSystems/#InfrastructureSystems.@scoped_enum-Tuple%7BAny,%20Vararg%7BAny,%20N%7D%20where%20N%7D)).
65

76
Example syntax:
7+
88
```
99
set_fuel!(gen, ThermalFuels.COAL)
1010
```
@@ -16,45 +16,45 @@ These predefined lists are below:
1616
`ACBusTypes` categorize buses for modeling activities and denote which quantities are specified
1717
for load flow calculations. `ACBusTypes` has the options:
1818

19-
| Name | Description |
20-
|:----------|:-------------|
21-
| `ISOLATED` | Disconnected from network |
22-
| `PQ` | Active and reactive power defined (load bus)|
23-
| `PV` | Active power and voltage magnitude defined (generator bus)|
24-
| `REF` | Reference bus (θ = 0)|
25-
| `SLACK` | Slack bus |
19+
| Name | Description |
20+
|:---------- |:---------------------------------------------------------- |
21+
| `ISOLATED` | Disconnected from network |
22+
| `PQ` | Active and reactive power defined (load bus) |
23+
| `PV` | Active power and voltage magnitude defined (generator bus) |
24+
| `REF` | Reference bus (θ = 0) |
25+
| `SLACK` | Slack bus |
2626

2727
## [Prime Movers](@id pm_list)
2828

2929
Each generator contains a field for `prime_mover::PrimeMovers`, based on the options in
3030
[EIA form 923](https://www.eia.gov/survey/form/eia_923/instructions.pdf).
3131
`PrimeMovers` has the options:
3232

33-
| Name | Description |
34-
|:----------|:-------------|
35-
| `BA` | Energy Storage, Battery |
36-
| `BT` | Turbines Used in a Binary Cycle (including those used for geothermal applications) |
37-
| `CA` | Combined-Cycle – Steam Part |
38-
| `CC` | Combined-Cycle - Aggregated Plant *augmentation of EIA |
39-
| `CE` | Energy Storage, Compressed Air |
40-
| `CP` | Energy Storage, Concentrated Solar Power |
41-
| `CS` | Combined-Cycle Single-Shaft Combustion turbine and steam turbine share a single generator |
42-
| `CT` | Combined-Cycle Combustion Turbine Part |
43-
| `ES` | Energy Storage, Other |
44-
| `FC` | Fuel Cell |
45-
| `FW` | Energy Storage, Flywheel |
46-
| `GT` | Combustion (Gas) Turbine (including jet engine design) |
47-
| `HA` | Hydrokinetic, Axial Flow Turbine |
48-
| `HB` | Hydrokinetic, Wave Buoy |
49-
| `HK` | Hydrokinetic, Other |
50-
| `HY` | Hydraulic Turbine (including turbines associated with delivery of water by pipeline) |
51-
| `IC` | Internal Combustion (diesel, piston, reciprocating) Engine |
52-
| `PS` | Energy Storage, Reversible Hydraulic Turbine (Pumped Storage) |
53-
| `OT` | Other |
54-
| `ST` | Steam Turbine (including nuclear, geothermal and solar steam; does not include combined-cycle turbine) |
55-
| `PVe` | Photovoltaic \(*Note*: renaming from EIA PV to PVe to avoid conflict with `ACBusType.PV`\) |
56-
| `WT` | Wind Turbine, Onshore |
57-
| `WS` | Wind Turbine, Offshore |
33+
| Name | Description |
34+
|:----- |:------------------------------------------------------------------------------------------------------ |
35+
| `BA` | Energy Storage, Battery |
36+
| `BT` | Turbines Used in a Binary Cycle (including those used for geothermal applications) |
37+
| `CA` | Combined-Cycle – Steam Part |
38+
| `CC` | Combined-Cycle - Aggregated Plant *augmentation of EIA |
39+
| `CE` | Energy Storage, Compressed Air |
40+
| `CP` | Energy Storage, Concentrated Solar Power |
41+
| `CS` | Combined-Cycle Single-Shaft Combustion turbine and steam turbine share a single generator |
42+
| `CT` | Combined-Cycle Combustion Turbine Part |
43+
| `ES` | Energy Storage, Other |
44+
| `FC` | Fuel Cell |
45+
| `FW` | Energy Storage, Flywheel |
46+
| `GT` | Combustion (Gas) Turbine (including jet engine design) |
47+
| `HA` | Hydrokinetic, Axial Flow Turbine |
48+
| `HB` | Hydrokinetic, Wave Buoy |
49+
| `HK` | Hydrokinetic, Other |
50+
| `HY` | Hydraulic Turbine (including turbines associated with delivery of water by pipeline) |
51+
| `IC` | Internal Combustion (diesel, piston, reciprocating) Engine |
52+
| `PS` | Energy Storage, Reversible Hydraulic Turbine (Pumped Storage) |
53+
| `OT` | Other |
54+
| `ST` | Steam Turbine (including nuclear, geothermal and solar steam; does not include combined-cycle turbine) |
55+
| `PVe` | Photovoltaic \(*Note*: renaming from EIA PV to PVe to avoid conflict with `ACBusType.PV`\) |
56+
| `WT` | Wind Turbine, Onshore |
57+
| `WS` | Wind Turbine, Offshore |
5858

5959
## [Fuels for Thermal Generators](@id tf_list)
6060

@@ -63,60 +63,60 @@ are intended to reflect the options in the
6363
[Aggregated Fuel Codes](https://www.eia.gov/survey/form/eia_923/instructions.pdf) from the
6464
EIA Annual Energy Review. `ThermalFuels` has the options:
6565

66-
| Name | EIA Fuel Code | Description |
67-
|:----------|:---------------|:-------------|
68-
| `COAL` | COL | Anthracite Coal and Bituminous Coal |
69-
| `WASTE_COAL` | WOC | Waste/Other Coal (includes anthracite culm, gob, fine coal, lignite waste, waste coal) |
70-
| `DISTILLATE_FUEL_OIL` | DFO | Distillate Fuel Oil (Diesel, No. 1, No. 2, and No. 4) |
71-
| `WASTE_OIL` | WOO | Waste Oil Kerosene and JetFuel Butane, Propane |
72-
| `PETROLEUM_COKE` | PC | Petroleum Coke |
73-
| `RESIDUAL_FUEL_OIL` | RFO | Residual Fuel Oil (No. 5, No. 6 Fuel Oils, and Bunker Oil) |
74-
| `NATURAL_GAS` | NG | Natural Gas |
75-
| `OTHER_GAS` | OOG | Other Gas and blast furnace gas |
76-
| `NUCLEAR` | NUC | Nuclear Fission (Uranium, Plutonium, Thorium) |
77-
| `AG_BIPRODUCT` | ORW | Agricultural Crop Byproducts/Straw/Energy Crops |
78-
| `MUNICIPAL_WASTE` | MLG | Municipal Solid Waste – Biogenic component |
79-
| `WOOD_WASTE` | WWW | Wood Waste Liquids excluding Black Liquor (BLQ) (Includes red liquor, sludge wood, spent sulfite liquor, and other wood-based liquids) |
80-
| `GEOTHERMAL` | GEO | Geothermal |
81-
| `OTHER` | OTH | Other |
66+
| Name | EIA Fuel Code | Description |
67+
|:--------------------- |:------------- |:-------------------------------------------------------------------------------------------------------------------------------------- |
68+
| `COAL` | COL | Anthracite Coal and Bituminous Coal |
69+
| `WASTE_COAL` | WOC | Waste/Other Coal (includes anthracite culm, gob, fine coal, lignite waste, waste coal) |
70+
| `DISTILLATE_FUEL_OIL` | DFO | Distillate Fuel Oil (Diesel, No. 1, No. 2, and No. 4) |
71+
| `WASTE_OIL` | WOO | Waste Oil Kerosene and JetFuel Butane, Propane |
72+
| `PETROLEUM_COKE` | PC | Petroleum Coke |
73+
| `RESIDUAL_FUEL_OIL` | RFO | Residual Fuel Oil (No. 5, No. 6 Fuel Oils, and Bunker Oil) |
74+
| `NATURAL_GAS` | NG | Natural Gas |
75+
| `OTHER_GAS` | OOG | Other Gas and blast furnace gas |
76+
| `NUCLEAR` | NUC | Nuclear Fission (Uranium, Plutonium, Thorium) |
77+
| `AG_BIPRODUCT` | ORW | Agricultural Crop Byproducts/Straw/Energy Crops |
78+
| `MUNICIPAL_WASTE` | MLG | Municipal Solid Waste – Biogenic component |
79+
| `WOOD_WASTE` | WWW | Wood Waste Liquids excluding Black Liquor (BLQ) (Includes red liquor, sludge wood, spent sulfite liquor, and other wood-based liquids) |
80+
| `GEOTHERMAL` | GEO | Geothermal |
81+
| `OTHER` | OTH | Other |
8282

8383
## [Energy Storage](@id storagetech_list)
8484

8585
`StorageTech` defines the storage technology used in an energy [`Storage`](@ref) system, based
8686
on the options in [EIA form 923](https://www.eia.gov/survey/form/eia_923/instructions.pdf).
8787
`StorageTech` has the options:
8888

89-
| Name | Description |
90-
|:----------|:-------------|
91-
| `PTES` | Pumped thermal energy storage |
92-
| `LIB` | LiON Battery |
93-
| `LAB` | Lead Acid Battery |
94-
| `FLWB` | Redox Flow Battery |
95-
| `SIB` | Sodium Ion Battery |
96-
| `ZIB` | Zinc Ion Battery |
97-
| `HGS` | Hydrogen Gas Storage |
98-
| `LAES` | Liquid Air Storage |
99-
| `OTHER_CHEM` | Other Chemical Storage |
100-
| `OTHER_MECH` | Other Mechanical Storage |
101-
| `OTHER_THERM` | Other Thermal Storage |
89+
| Name | Description |
90+
|:------------- |:----------------------------- |
91+
| `PTES` | Pumped thermal energy storage |
92+
| `LIB` | LiON Battery |
93+
| `LAB` | Lead Acid Battery |
94+
| `FLWB` | Redox Flow Battery |
95+
| `SIB` | Sodium Ion Battery |
96+
| `ZIB` | Zinc Ion Battery |
97+
| `HGS` | Hydrogen Gas Storage |
98+
| `LAES` | Liquid Air Storage |
99+
| `OTHER_CHEM` | Other Chemical Storage |
100+
| `OTHER_MECH` | Other Mechanical Storage |
101+
| `OTHER_THERM` | Other Thermal Storage |
102102

103103
## [Dynamic States](@id states_list)
104104

105105
`StateTypes` are used to denote the type of dynamic equation a specific [state](@ref S) is subject
106106
to in [`PowerSimulationsDynamics.jl`](https://nrel-sienna.github.io/PowerSimulationsDynamics.jl/stable/).
107107
`StateTypes` has the options:
108108

109-
| Name | Description |
110-
|:----------|:-------------|
111-
| `Differential` | State evolves over time via a differential equation ``\dot{x} = f(x)`` |
112-
| `Algebraic` | State evolves over time by satisfying an algebraic equation ``0 = g(x)`` |
113-
| `Hybrid` | Depending on specific parameters, the state can be `Differential` or `Algebraic` |
109+
| Name | Description |
110+
|:-------------- |:-------------------------------------------------------------------------------- |
111+
| `Differential` | State evolves over time via a differential equation ``\dot{x} = f(x)`` |
112+
| `Algebraic` | State evolves over time by satisfying an algebraic equation ``0 = g(x)`` |
113+
| `Hybrid` | Depending on specific parameters, the state can be `Differential` or `Algebraic` |
114114

115115
## [Angle Units](@id angleunits_list)
116116

117117
`AngleUnits` can be specified in:
118118

119-
| Name |
120-
|----------|
119+
| Name |
120+
|:--------- |
121121
| `DEGREES` |
122-
| `RADIANS` |
122+
| `RADIANS` |

0 commit comments

Comments
 (0)