Skip to content

Commit

Permalink
build based on fd3de10
Browse files Browse the repository at this point in the history
  • Loading branch information
Documenter.jl committed Aug 28, 2024
1 parent 59bcde2 commit 87206b6
Show file tree
Hide file tree
Showing 94 changed files with 3,654 additions and 3,547 deletions.
2 changes: 1 addition & 1 deletion dev/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><hr/><p>PowerSystems has been developed as part of the <a href="https://www.nrel.gov/analysis/sienna.html">Sienna modeling framework</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="../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="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 0.27.25 on <span class="colophon-date" title="Wednesday 28 August 2024 20:44">Wednesday 28 August 2024</span>. Using Julia version 1.10.5.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
keywords = {Power Systems, Julia, Energy},</code></pre><hr/><p>PowerSystems has been developed as part of the <a href="https://www.nrel.gov/analysis/sienna.html">Sienna modeling framework</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="../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="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 0.27.25 on <span class="colophon-date" title="Wednesday 28 August 2024 20:51">Wednesday 28 August 2024</span>. Using Julia version 1.10.5.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
2 changes: 1 addition & 1 deletion dev/api/developer_guidelines/index.html

Large diffs are not rendered by default.

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

Large diffs are not rendered by default.

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

Large diffs are not rendered by default.

623 changes: 313 additions & 310 deletions dev/api/internal/index.html

Large diffs are not rendered by default.

274 changes: 137 additions & 137 deletions dev/api/public/index.html

Large diffs are not rendered by default.

5 changes: 3 additions & 2 deletions dev/api/type_tree/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,8 @@
│ │ │ │ ├─ PowerSystems.EXST1
│ │ │ │ ├─ SCRX
│ │ │ │ ├─ SEXS
│ │ │ │ └─ ST6B
│ │ │ │ ├─ ST6B
│ │ │ │ └─ ST8C
│ │ │ ├─ Machine
│ │ │ │ ├─ AndersonFouadMachine
│ │ │ │ ├─ BaseMachine
Expand Down Expand Up @@ -227,4 +228,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="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 0.27.25 on <span class="colophon-date" title="Wednesday 28 August 2024 20:44">Wednesday 28 August 2024</span>. Using Julia version 1.10.5.</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="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 0.27.25 on <span class="colophon-date" title="Wednesday 28 August 2024 20:51">Wednesday 28 August 2024</span>. Using Julia version 1.10.5.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
2 changes: 1 addition & 1 deletion dev/api/valuecurve_options/index.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion dev/explanation/example_dynamic_data/index.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion dev/explanation/per_unit/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -231,4 +231,4 @@
[ Info: Reading branch data
[ Info: Reading shunt data
[ Info: Reading DC Line data
[ Info: Reading storage data</code><br/><code class="language-julia-repl hljs" style="display:block;">julia&gt; get_units_base(system)</code><code class="nohighlight hljs ansi" style="display:block;">&quot;SYSTEM_BASE&quot;</code></pre><p>To change the unit system setting of a <code>System</code>:</p><pre><code class="language-julia-repl hljs" style="display:block;">julia&gt; set_units_base_system!(system, &quot;DEVICE_BASE&quot;)</code><code class="nohighlight hljs ansi" style="display:block;">[ Info: Unit System changed to UnitSystem.DEVICE_BASE = 1</code></pre><p>The units of the parameter values stored in each struct are defined in <code>src/descriptors/power_system_structs.json</code>. Conversion between unit systems does not change the stored parameter values. Instead, unit system conversions are made when accessing parameters using the <a href="../system/#dot_access">accessor functions</a>, thus making it imperative to utilize the accessor functions instead of the &quot;dot&quot; accessor methods to ensure the return of the correct values.</p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../type_structure/">« Type Structure</a><a class="docs-footer-nextpage" href="../time_series/">Time Series Data »</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="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 0.27.25 on <span class="colophon-date" title="Wednesday 28 August 2024 20:44">Wednesday 28 August 2024</span>. Using Julia version 1.10.5.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
[ Info: Reading storage data</code><br/><code class="language-julia-repl hljs" style="display:block;">julia&gt; get_units_base(system)</code><code class="nohighlight hljs ansi" style="display:block;">&quot;SYSTEM_BASE&quot;</code></pre><p>To change the unit system setting of a <code>System</code>:</p><pre><code class="language-julia-repl hljs" style="display:block;">julia&gt; set_units_base_system!(system, &quot;DEVICE_BASE&quot;)</code><code class="nohighlight hljs ansi" style="display:block;">[ Info: Unit System changed to UnitSystem.DEVICE_BASE = 1</code></pre><p>The units of the parameter values stored in each struct are defined in <code>src/descriptors/power_system_structs.json</code>. Conversion between unit systems does not change the stored parameter values. Instead, unit system conversions are made when accessing parameters using the <a href="../system/#dot_access">accessor functions</a>, thus making it imperative to utilize the accessor functions instead of the &quot;dot&quot; accessor methods to ensure the return of the correct values.</p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../type_structure/">« Type Structure</a><a class="docs-footer-nextpage" href="../time_series/">Time Series Data »</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="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 0.27.25 on <span class="colophon-date" title="Wednesday 28 August 2024 20:51">Wednesday 28 August 2024</span>. Using Julia version 1.10.5.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
2 changes: 1 addition & 1 deletion dev/explanation/system/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -500,4 +500,4 @@
│ 102_STEAM_4 │ true │ 0.76 │ -0.0231 │
│ 107_CC_1 │ true │ 3.55 │ 0.4951 │
└─────────────────┴───────────┴──────────────┴────────────────┘</code></pre><h2 id="JSON-Serialization"><a class="docs-heading-anchor" href="#JSON-Serialization">JSON Serialization</a><a id="JSON-Serialization-1"></a><a class="docs-heading-anchor-permalink" href="#JSON-Serialization" title="Permalink"></a></h2><p><code>PowerSystems.jl</code> provides functionality to serialize an entire system to a JSON file and then deserialize it back to a system. The main benefit is that deserializing is significantly faster than reconstructing the system from raw data files.</p><p>The function that serializes the system <a href="../../api/public/#InfrastructureSystems.to_json-Tuple{System, AbstractString}"><code>to_json</code></a> requires the system and a file name</p><pre><code class="language-julia hljs">to_json(system, &quot;system.json&quot;)</code></pre><p>The serialization process stores 3 files</p><ol><li>System data file (<code>*.json</code> file)</li><li>Validation data file (<code>*.json</code> file)</li><li>Time Series data file (<code>*.h5</code> file)</li></ol><p>To deserialize:</p><pre><code class="language-julia hljs">system2 = System(&quot;system.json&quot;)</code></pre><p>PowerSystems generates UUIDs for the System and all components in order to have a way to uniquely identify objects. During deserialization it restores the same UUIDs. If you will modify the System or components after deserialization then it is recommended that you set this flag to generate new UUIDs.</p><pre><code class="language-julia hljs">system2 = System(&quot;system.json&quot;, assign_new_uuids = true)</code></pre><h2 id="Viewing-PowerSystems-Data-in-JSON-Format"><a class="docs-heading-anchor" href="#Viewing-PowerSystems-Data-in-JSON-Format">Viewing PowerSystems Data in JSON Format</a><a id="Viewing-PowerSystems-Data-in-JSON-Format-1"></a><a class="docs-heading-anchor-permalink" href="#Viewing-PowerSystems-Data-in-JSON-Format" title="Permalink"></a></h2><p>PowerSystems data can be serialized and deserialized in JSON. This section shows how to explore the data outside of Julia using.</p><pre><code class="language-julia hljs">system = System(&quot;system.json&quot;)</code></pre><p>It can be useful to view and filter the PowerSystems data in this format. There are many tools available to browse JSON data.</p><p>Here is an example <a href="http://jsonviewer.stack.hu">GUI tool</a> that is available online in a browser.</p><p>The command line utility <a href="https://stedolan.github.io/jq/">jq</a> offers even more features. The rest of this document provides example commands.</p><ul><li>View the entire file pretty-printed</li></ul><pre><code class="language-zsh hljs">jq . system.json</code></pre><ul><li>View the PowerSystems component types</li></ul><pre><code class="language-zsh hljs">jq &#39;.data.components | .[] | .__metadata__ | .type&#39; system.json | sort | uniq</code></pre><ul><li>View specific components</li></ul><pre><code class="language-zsh hljs">jq &#39;.data.components | .[] | select(.__metadata__.type == &quot;ThermalStandard&quot;)&#39; system.json</code></pre><ul><li>Get the count of a component type</li></ul><pre><code class="language-zsh hljs"># There is almost certainly a better way.
jq &#39;.data.components | .[] | select(.__metadata__.type == &quot;ThermalStandard&quot;)&#39; system.json | grep -c ThermalStandard</code></pre><ul><li>View specific component by name</li></ul><pre><code class="language-zsh hljs">jq &#39;.data.components | .[] | select(.__metadata__.type == &quot;ThermalStandard&quot; and .name == &quot;107_CC_1&quot;)&#39; system.json</code></pre><ul><li>Filter on a field value</li></ul><pre><code class="language-zsh hljs">jq &#39;.data.components | .[] | select(.__metadata__.type == &quot;ThermalStandard&quot; and .active_power &gt; 2.3)&#39; system.json</code></pre></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../../how_to/migrating_to_psy4/">« ...migrate from version 3.0 to 4.0</a><a class="docs-footer-nextpage" href="../type_structure/">Type Structure »</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="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 0.27.25 on <span class="colophon-date" title="Wednesday 28 August 2024 20:44">Wednesday 28 August 2024</span>. Using Julia version 1.10.5.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
jq &#39;.data.components | .[] | select(.__metadata__.type == &quot;ThermalStandard&quot;)&#39; system.json | grep -c ThermalStandard</code></pre><ul><li>View specific component by name</li></ul><pre><code class="language-zsh hljs">jq &#39;.data.components | .[] | select(.__metadata__.type == &quot;ThermalStandard&quot; and .name == &quot;107_CC_1&quot;)&#39; system.json</code></pre><ul><li>Filter on a field value</li></ul><pre><code class="language-zsh hljs">jq &#39;.data.components | .[] | select(.__metadata__.type == &quot;ThermalStandard&quot; and .active_power &gt; 2.3)&#39; system.json</code></pre></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../../how_to/migrating_to_psy4/">« ...migrate from version 3.0 to 4.0</a><a class="docs-footer-nextpage" href="../type_structure/">Type Structure »</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="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 0.27.25 on <span class="colophon-date" title="Wednesday 28 August 2024 20:51">Wednesday 28 August 2024</span>. Using Julia version 1.10.5.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
Loading

0 comments on commit 87206b6

Please sign in to comment.