Skip to content
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

Documentation clean up, update to Documenter 1.0, add *.md to formatter (PSY portion) #1176

Merged
merged 46 commits into from
Sep 23, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
46 commits
Select commit Hold shift + click to select a range
50ebe26
Consolidate IS TS docs in API, add TimeSeriesKey, remove valuecurve p…
kdayday Aug 17, 2024
7e6e5a3
Bug fix
kdayday Aug 17, 2024
ac96a25
Add staticTimeSeries to API and remove IS TS filters to simplify trac…
kdayday Aug 17, 2024
28b84b1
Move trouble-shooting serialization issues under custom components
kdayday Aug 19, 2024
9e0dba8
Add valuecurves to API after move to IS
kdayday Aug 19, 2024
7251b43
Add DynamicInjection devices to model library
kdayday Aug 20, 2024
2fadabf
Update to Documenter 1.0 enforcing everything except doc size and mis…
kdayday Aug 20, 2024
3db9abd
Add next steps links in ts tutorial
kdayday Aug 30, 2024
8839020
Update dynamic data tutorial by merging with tutorial from PSID
kdayday Aug 30, 2024
0938aeb
Add branch abstract type docstrings
kdayday Aug 30, 2024
607fb11
Add links and default values to DynamicGenerator and Inverter docstrings
kdayday Aug 30, 2024
a24c8ed
Change JSON how-to from temp to more realistic folder name
kdayday Sep 2, 2024
ed24940
Add markdown files to JuliaFormatter script and run formatter on all …
kdayday Sep 2, 2024
9ab25cb
Bug fix getting started list format
kdayday Sep 2, 2024
43abcd4
Move examples from system.md to json how-to and draft tutorial on get…
kdayday Sep 3, 2024
14c6349
Run formatter
kdayday Sep 3, 2024
ee56ad5
Expand per unit explanation and update Branch rating docstrings
kdayday Sep 3, 2024
40f6fcc
Correct base power docstring for dynamic_inverter and _generator
kdayday Sep 3, 2024
318eeba
Correct per unit page
kdayday Sep 3, 2024
5633e37
Merge branch 'main' into docs_cleanup
kdayday Sep 3, 2024
2d63ee6
Remove under construction warning
kdayday Sep 3, 2024
77771b3
Add how to add component in natural units
kdayday Sep 9, 2024
a7ada48
Run formatter
kdayday Sep 9, 2024
3d78fbb
Add missing PSY pages to api
kdayday Sep 10, 2024
7c06427
add docstrings to outer control
rodrigomha Sep 10, 2024
f60d7a3
update outer control manual markdown
rodrigomha Sep 10, 2024
f3a3d03
Add Outercontrol setters
kdayday Sep 11, 2024
b8deb42
Add parse_file kwargs in docstring
kdayday Sep 11, 2024
d090c58
Remove duplicate autodocs in public api
kdayday Sep 11, 2024
ecab80f
Typo fix
kdayday Sep 16, 2024
25c4141
Merge branch 'missing_docstrings' into docs_cleanup
kdayday Sep 16, 2024
74be27b
Run formatter
kdayday Sep 16, 2024
98e384f
Move and collapse internal API
kdayday Sep 17, 2024
b8c0441
Add Rodrigo to authors
kdayday Sep 17, 2024
c3113be
Reorder PowerSystems.jl to track down IS files
kdayday Sep 17, 2024
fb41e06
Filter IS docs by what's exported in PSY, remove IS from makedocs, re…
kdayday Sep 17, 2024
181b971
Fix parsing.md text formatting
kdayday Sep 19, 2024
68534a0
Add missing glossary entries
kdayday Sep 19, 2024
0b9a5ba
Update docs/src/explanation/dynamic_data.md
kdayday Sep 19, 2024
f7cfb8c
Update docs/src/api/citation.md
kdayday Sep 19, 2024
e091e16
Update docs/src/explanation/dynamic_data.md
kdayday Sep 19, 2024
605d34c
Remove comment in draft tutorial
kdayday Sep 19, 2024
d1603e7
Recopy PowerModels licenses, fix file name, exclude from formatter
kdayday Sep 19, 2024
fc70629
Break up parsing how-to to 4 topics and clean up, add deprecation war…
kdayday Sep 19, 2024
be03b71
run formatter
kdayday Sep 19, 2024
ba1a44d
Merge branch 'main' into docs_cleanup
kdayday Sep 19, 2024
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
2 changes: 1 addition & 1 deletion docs/Project.toml
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,6 @@ TypeTree = "04da0e3b-1cad-4b2c-a963-fc1602baf1af"

[compat]
CSV = "~0.10"
Documenter = "^0.27"
Documenter = "^1.5"
InfrastructureSystems = "2"
julia = "^1.6"
42 changes: 24 additions & 18 deletions docs/make.jl
Original file line number Diff line number Diff line change
Expand Up @@ -12,22 +12,24 @@ pages = OrderedDict(
"Tutorials" => Any[
"Create and Explore a Power `System`" => "tutorials/creating_system.md",
"Working with Time Series" => "tutorials/working_with_time_series.md",
"Adding dynamic devices" => "tutorials/add_dynamic_device.md",
"Adding Data for Dynamic Simulations" => "tutorials/add_dynamic_data.md",
],
"How to..." => Any[
"...install PowerSystems.jl" => "how_to/install.md",
"...load a `system` from `PowerSystemCaseBuilder`" => "how_to/powersystembuilder.md",
"...parse data from Matpower, PSSE, or CSV files" => "how_to/parsing.md",
"...add time series data from CSVs" => "how_to/add_ts_from_csvs.md",
"...customize the tabular data parser" => "how_to/extend_tabular_parsing.md",
"...parse data from MATPOWER or PSS/e files" => "how_to/parse_matpower_psse.md",
"...parse PSS/e dynamic data" => "how_to/parse_dynamic_data.md",
"...parse tabular data from .csv files" => "how_to/parse_tabular_data.md",
"...parse time series data from .csv files" => "how_to/parse_ts_from_csvs.md",
"...add a component using natural units (MW)" => "how_to/add_component_natural_units.md",
"...get all the buses in a system" => "how_to/get_buses.md",
"...get the available generators in a system" => "how_to/get_available_generators.md",
"...add an Operating Cost" => "how_to/add_cost_curve.md",
"...add a market bid" => "how_to/market_bid_cost.md",
"...add additional data to a component" => "how_to/adding_additional_fields.md",
"...add a new Type" => "how_to/add_new_types.md",
"...customize or add a new Type" => "how_to/add_new_types.md",
"...improve performance with time series data" => "how_to/improve_ts_performance.md",
"...serialize data to a JSON" => "how_to/serialize_data.md",
"...write and read data with a JSON" => "how_to/serialize_data.md",
"...reduce REPL printing" => "how_to/reduce_repl_printing.md",
"...migrate from version 3.0 to 4.0" => "how_to/migrating_to_psy4.md"
],
Expand All @@ -37,18 +39,18 @@ pages = OrderedDict(
"explanation/type_structure.md",
"explanation/per_unit.md",
"explanation/time_series.md",
"explanation/example_dynamic_data.md",
"explanation/dynamic_data.md",
],
"Model Library" => Any[],
"Reference" =>
Any["Public API" => "api/public.md",
"Internal API Reference" => "api/internal.md",
"Glossary and Acronyms" => "api/glossary.md",
"Type Hierarchy" => "api/type_tree.md",
"`ValueCurve` Options" => "api/valuecurve_options.md",
"Specifying the category of..." => "api/enumerated_types.md",
"Developer Guidelines" => "api/developer_guidelines.md",
"Citation" => "api/citation.md"
"Citation" => "api/citation.md",
"Developers" => ["Developer Guidelines" => "api/developer_guidelines.md",
"Internals" => "api/internal.md"]
]


Expand All @@ -59,14 +61,17 @@ pages["Model Library"] = make_model_library(
Topology,
StaticInjection,
Service,
Branch
Branch,
DynamicInjection,
],
exceptions = [PSY.DynamicComponent,
PSY.ActivePowerControl,
PSY.ReactivePowerControl,
PSY.DynamicBranch,
PSY.HybridSystem,
PSY.OperationalCost
PSY.OperationalCost,
PSY.DynamicInverter,
PSY.DynamicGenerator,
],
manual_additions =
Dict("Service" => ["Reserves" => "model_library/reserves.md"],
Expand All @@ -81,8 +86,6 @@ pages["Model Library"] = make_model_library(
"StorageCost" =>"model_library/storage_cost.md",
"LoadCost" =>"model_library/load_cost.md",
"MarketBidCost" =>"model_library/market_bid_cost.md"],
"Cost Curves" => ["Variable Cost Curves" => "model_library/cost_curves.md",
"Value Curves" => "model_library/value_curves.md"]
)
)

Expand Down Expand Up @@ -128,11 +131,14 @@ for (section, folder) in folders
end

makedocs(
modules = [PowerSystems, InfrastructureSystems],
format = Documenter.HTML(prettyurls = haskey(ENV, "GITHUB_ACTIONS"),),
modules = [PowerSystems],
format = Documenter.HTML(
prettyurls = haskey(ENV, "GITHUB_ACTIONS"),
size_threshold = nothing,),
sitename = "PowerSystems.jl",
authors = "Jose Daniel Lara, Daniel Thom, Kate Doubleday, and Clayton Barrows",
pages = Any[p for p in pages]
authors = "Jose Daniel Lara, Daniel Thom, Kate Doubleday, Rodrigo Henriquez-Auba, and Clayton Barrows",
pages = Any[p for p in pages],
draft = false,
)

deploydocs(
Expand Down
3 changes: 1 addition & 2 deletions docs/src/api/citation.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,6 @@ author = {José Daniel Lara and Clayton Barrows and Daniel Thom and Dheepak Kris
keywords = {Power Systems, Julia, Energy},
```

------------
PowerSystems has been developed as part of the [Sienna modeling framework](https://www.nrel.gov/analysis/sienna.html)
PowerSystems has been developed as part of the [Sienna platform](https://www.nrel.gov/analysis/sienna.html)
by the U.S. Department of Energy's National Renewable Energy Laboratory
([NREL](https://www.nrel.gov/)).
4 changes: 2 additions & 2 deletions docs/src/api/developer_guidelines.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@ In order to contribute to `PowerSystems.jl` repository please read the following
[`InfrastructureSystems.jl`](https://github.com/NREL-Sienna/InfrastructureSystems.jl)
documentation in detail:

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

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

Expand Down
142 changes: 71 additions & 71 deletions docs/src/api/enumerated_types.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@

# Specifying the type of...

Some fields in PowerSystems.jl are specified with an option from a pre-defined list
(Specified with [`IS.scoped_enums`](https://nrel-sienna.github.io/InfrastructureSystems.jl/stable/InfrastructureSystems/#InfrastructureSystems.@scoped_enum-Tuple{Any,%20Vararg{Any,%20N}%20where%20N})).
(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)).

Example syntax:

```
set_fuel!(gen, ThermalFuels.COAL)
```
Expand All @@ -16,45 +16,45 @@ These predefined lists are below:
`ACBusTypes` categorize buses for modeling activities and denote which quantities are specified
for load flow calculations. `ACBusTypes` has the options:

| Name | Description |
|:----------|:-------------|
| `ISOLATED` | Disconnected from network |
| `PQ` | Active and reactive power defined (load bus)|
| `PV` | Active power and voltage magnitude defined (generator bus)|
| `REF` | Reference bus (θ = 0)|
| `SLACK` | Slack bus |
| Name | Description |
|:---------- |:---------------------------------------------------------- |
| `ISOLATED` | Disconnected from network |
| `PQ` | Active and reactive power defined (load bus) |
| `PV` | Active power and voltage magnitude defined (generator bus) |
| `REF` | Reference bus (θ = 0) |
| `SLACK` | Slack bus |

## [Prime Movers](@id pm_list)

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

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

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

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

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

## [Energy Storage](@id storagetech_list)

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

| Name | Description |
|:----------|:-------------|
| `PTES` | Pumped thermal energy storage |
| `LIB` | LiON Battery |
| `LAB` | Lead Acid Battery |
| `FLWB` | Redox Flow Battery |
| `SIB` | Sodium Ion Battery |
| `ZIB` | Zinc Ion Battery |
| `HGS` | Hydrogen Gas Storage |
| `LAES` | Liquid Air Storage |
| `OTHER_CHEM` | Other Chemical Storage |
| `OTHER_MECH` | Other Mechanical Storage |
| `OTHER_THERM` | Other Thermal Storage |
| Name | Description |
|:------------- |:----------------------------- |
| `PTES` | Pumped thermal energy storage |
| `LIB` | LiON Battery |
| `LAB` | Lead Acid Battery |
| `FLWB` | Redox Flow Battery |
| `SIB` | Sodium Ion Battery |
| `ZIB` | Zinc Ion Battery |
| `HGS` | Hydrogen Gas Storage |
| `LAES` | Liquid Air Storage |
| `OTHER_CHEM` | Other Chemical Storage |
| `OTHER_MECH` | Other Mechanical Storage |
| `OTHER_THERM` | Other Thermal Storage |

## [Dynamic States](@id states_list)

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

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

## [Angle Units](@id angleunits_list)

`AngleUnits` can be specified in:

| Name |
|----------|
| Name |
|:--------- |
| `DEGREES` |
| `RADIANS` |
| `RADIANS` |
Loading
Loading