Skip to content

Commit

Permalink
build based on c7348f6
Browse files Browse the repository at this point in the history
  • Loading branch information
Documenter.jl committed Oct 22, 2024
1 parent c3b6e61 commit 39866fd
Show file tree
Hide file tree
Showing 103 changed files with 4,254 additions and 4,254 deletions.
2 changes: 1 addition & 1 deletion previews/PR1205/.documenter-siteinfo.json
Original file line number Diff line number Diff line change
@@ -1 +1 @@
{"documenter":{"julia_version":"1.11.1","generation_timestamp":"2024-10-22T19:27:27","documenter_version":"1.7.0"}}
{"documenter":{"julia_version":"1.11.1","generation_timestamp":"2024-10-22T19:52:08","documenter_version":"1.7.0"}}
2 changes: 1 addition & 1 deletion previews/PR1205/api/citation/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -9,4 +9,4 @@
doi = {https://doi.org/10.1016/j.softx.2021.100747},
url = {https://www.sciencedirect.com/science/article/pii/S2352711021000765},
author = {José Daniel Lara and Clayton Barrows and Daniel Thom and Dheepak Krishnamurthy and Duncan Callaway},
keywords = {Power Systems, Julia, Energy},</code></pre><p>PowerSystems has been developed as part of the <a href="https://www.nrel.gov/analysis/sienna.html">Sienna platform</a> by the U.S. Department of Energy&#39;s National Renewable Energy Laboratory (<a href="https://www.nrel.gov/">NREL</a>).</p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../enumerated_types/">« Specifying the category of...</a><a class="docs-footer-nextpage" href="../developer_guidelines/">Developer Guidelines »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.7.0 on <span class="colophon-date" title="Tuesday 22 October 2024 19:27">Tuesday 22 October 2024</span>. Using Julia version 1.11.1.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
keywords = {Power Systems, Julia, Energy},</code></pre><p>PowerSystems has been developed as part of the <a href="https://www.nrel.gov/analysis/sienna.html">Sienna platform</a> by the U.S. Department of Energy&#39;s National Renewable Energy Laboratory (<a href="https://www.nrel.gov/">NREL</a>).</p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../enumerated_types/">« Specifying the category of...</a><a class="docs-footer-nextpage" href="../developer_guidelines/">Developer Guidelines »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.7.0 on <span class="colophon-date" title="Tuesday 22 October 2024 19:52">Tuesday 22 October 2024</span>. Using Julia version 1.11.1.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
2 changes: 1 addition & 1 deletion previews/PR1205/api/developer_guidelines/index.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion previews/PR1205/api/enumerated_types/index.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion previews/PR1205/api/glossary/index.html

Large diffs are not rendered by default.

636 changes: 318 additions & 318 deletions previews/PR1205/api/internal/index.html

Large diffs are not rendered by default.

340 changes: 170 additions & 170 deletions previews/PR1205/api/public/index.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion previews/PR1205/api/type_tree/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -230,4 +230,4 @@
│ └─ SingleTimeSeries
└─ TimeSeriesKey
├─ ForecastKey
└─ StaticTimeSeriesKey</code></pre></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../glossary/">« Glossary and Acronyms</a><a class="docs-footer-nextpage" href="../valuecurve_options/"><code>ValueCurve</code> Options »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.7.0 on <span class="colophon-date" title="Tuesday 22 October 2024 19:27">Tuesday 22 October 2024</span>. Using Julia version 1.11.1.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
└─ StaticTimeSeriesKey</code></pre></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../glossary/">« Glossary and Acronyms</a><a class="docs-footer-nextpage" href="../valuecurve_options/"><code>ValueCurve</code> Options »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.7.0 on <span class="colophon-date" title="Tuesday 22 October 2024 19:52">Tuesday 22 October 2024</span>. Using Julia version 1.11.1.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
2 changes: 1 addition & 1 deletion previews/PR1205/api/valuecurve_options/index.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion previews/PR1205/explanation/dynamic_data/index.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion previews/PR1205/explanation/per_unit/index.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion previews/PR1205/explanation/system/index.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion previews/PR1205/explanation/time_series/index.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion previews/PR1205/explanation/type_structure/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -11,4 +11,4 @@
load_zone::Union{Nothing, LoadZone}
ext::Dict{String, Any}
internal::InfrastructureSystems.InfrastructureSystemsInternal
end</code></pre><h3 id="Type-Hierarchy"><a class="docs-heading-anchor" href="#Type-Hierarchy">Type Hierarchy</a><a id="Type-Hierarchy-1"></a><a class="docs-heading-anchor-permalink" href="#Type-Hierarchy" title="Permalink"></a></h3><p>PowerSystems is intended to organize data by the behavior of the devices that the data represents. A type hierarchy has been defined with several levels of abstract types starting with <code>InfrastructureSystemsType</code>. There are a bunch of subtypes of <code>InfrastructureSystemsType</code>, but the important ones to know about are:</p><ul><li><p><code>System</code>: overarching <code>struct</code> that collects all of the <code>Component</code>s</p></li><li><p><code>Component</code>: includes all elements of power system data</p><ul><li><code>Topology</code>: includes non physical elements describing network connectivity</li><li><code>Service</code>: includes descriptions of system requirements (other than energy balance)</li><li><code>Device</code>: includes descriptions of all the physical devices in a power system</li></ul></li><li><p><code>InfrastructureSystems.DeviceParameter</code>: includes structs that hold data describing the dynamic, or economic capabilities of <code>Device</code>.</p></li><li><p><code>TimeSeriesData</code>: Includes all time series types</p><ul><li><code>Forecast</code>: includes structs to define time series of forecasted data where multiple values can represent each time stamp</li><li><code>StaticTimeSeries</code>: includes structs to define time series with a single value for each time stamp</li></ul></li></ul><p>The abstract hierarchy enables categorization of the devices by their operational characteristics and modeling requirements.</p><p>For instance, generation is classified by the distinctive data requirements for modeling in three categories: <a href="../../api/public/#PowerSystems.ThermalGen"><code>ThermalGen</code></a>, <a href="../../api/public/#PowerSystems.RenewableGen"><code>RenewableGen</code></a>, and <a href="../../api/public/#PowerSystems.HydroGen"><code>HydroGen</code></a>.</p><p><code>PowerSystems.jl</code> has a category <a href="../../api/public/#PowerSystems.Topology"><code>Topology</code></a> of topological components (e.g., <a href="../../model_library/generated_ACBus/#ACBus"><code>ACBus</code></a>, <a href="../../model_library/generated_Arc/#Arc"><code>Arc</code></a>), separate from the physical components.</p><p>The hierarchy also includes components absent in standard data models, such as services. The services category includes reserves, transfers and <a href="../../model_library/generated_AGC/#AGC"><code>AGC</code></a>. The power of <code>PowerSystems.jl</code> lies in providing the abstraction without an implicit mathematical representation of the component.</p><p>As a result of this design, developers can define model logic entirely based on abstract types and create generic code to support modeling technologies that are not yet implemented in the package.</p><img src="../../assets/AbstractTree.png" width="75%"/><p>⠀ ```</p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../system/">« System</a><a class="docs-footer-nextpage" href="../per_unit/">Per-unit Conventions »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.7.0 on <span class="colophon-date" title="Tuesday 22 October 2024 19:27">Tuesday 22 October 2024</span>. Using Julia version 1.11.1.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
end</code></pre><h3 id="Type-Hierarchy"><a class="docs-heading-anchor" href="#Type-Hierarchy">Type Hierarchy</a><a id="Type-Hierarchy-1"></a><a class="docs-heading-anchor-permalink" href="#Type-Hierarchy" title="Permalink"></a></h3><p>PowerSystems is intended to organize data by the behavior of the devices that the data represents. A type hierarchy has been defined with several levels of abstract types starting with <code>InfrastructureSystemsType</code>. There are a bunch of subtypes of <code>InfrastructureSystemsType</code>, but the important ones to know about are:</p><ul><li><p><code>System</code>: overarching <code>struct</code> that collects all of the <code>Component</code>s</p></li><li><p><code>Component</code>: includes all elements of power system data</p><ul><li><code>Topology</code>: includes non physical elements describing network connectivity</li><li><code>Service</code>: includes descriptions of system requirements (other than energy balance)</li><li><code>Device</code>: includes descriptions of all the physical devices in a power system</li></ul></li><li><p><code>InfrastructureSystems.DeviceParameter</code>: includes structs that hold data describing the dynamic, or economic capabilities of <code>Device</code>.</p></li><li><p><code>TimeSeriesData</code>: Includes all time series types</p><ul><li><code>Forecast</code>: includes structs to define time series of forecasted data where multiple values can represent each time stamp</li><li><code>StaticTimeSeries</code>: includes structs to define time series with a single value for each time stamp</li></ul></li></ul><p>The abstract hierarchy enables categorization of the devices by their operational characteristics and modeling requirements.</p><p>For instance, generation is classified by the distinctive data requirements for modeling in three categories: <a href="../../api/public/#PowerSystems.ThermalGen"><code>ThermalGen</code></a>, <a href="../../api/public/#PowerSystems.RenewableGen"><code>RenewableGen</code></a>, and <a href="../../api/public/#PowerSystems.HydroGen"><code>HydroGen</code></a>.</p><p><code>PowerSystems.jl</code> has a category <a href="../../api/public/#PowerSystems.Topology"><code>Topology</code></a> of topological components (e.g., <a href="../../model_library/generated_ACBus/#ACBus"><code>ACBus</code></a>, <a href="../../model_library/generated_Arc/#Arc"><code>Arc</code></a>), separate from the physical components.</p><p>The hierarchy also includes components absent in standard data models, such as services. The services category includes reserves, transfers and <a href="../../model_library/generated_AGC/#AGC"><code>AGC</code></a>. The power of <code>PowerSystems.jl</code> lies in providing the abstraction without an implicit mathematical representation of the component.</p><p>As a result of this design, developers can define model logic entirely based on abstract types and create generic code to support modeling technologies that are not yet implemented in the package.</p><img src="../../assets/AbstractTree.png" width="75%"/><p>⠀ ```</p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../system/">« System</a><a class="docs-footer-nextpage" href="../per_unit/">Per-unit Conventions »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.7.0 on <span class="colophon-date" title="Tuesday 22 October 2024 19:52">Tuesday 22 October 2024</span>. Using Julia version 1.11.1.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
Loading

0 comments on commit 39866fd

Please sign in to comment.