Update 0.3 docs

This commit is contained in:
2022-07-17 15:56:26 -06:00
parent f8bc9d3e0c
commit 7a0d38b581
8 changed files with 66 additions and 31 deletions

View File

@@ -103,4 +103,4 @@
}</code></pre><h3 id="Additional-remarks"><a class="docs-heading-anchor" href="#Additional-remarks">Additional remarks</a><a id="Additional-remarks-1"></a><a class="docs-heading-anchor-permalink" href="#Additional-remarks" title="Permalink"></a></h3><h4 id="Time-series-parameters"><a class="docs-heading-anchor" href="#Time-series-parameters">Time series parameters</a><a id="Time-series-parameters-1"></a><a class="docs-heading-anchor-permalink" href="#Time-series-parameters" title="Permalink"></a></h4><p>Many numerical properties in the JSON file can be specified either as a single floating point number if they are time-independent, or as an array containing exactly <code>T</code> elements, if they are time-dependent, where <code>T</code> is the number of time steps in the planning horizon. For example, both formats below are valid when <code>T=3</code>:</p><pre><code class="language-json hljs">{
&quot;Load (MW)&quot;: 800.0,
&quot;Load (MW)&quot;: [800.0, 850.0, 730.0]
}</code></pre><p>The value <code>T</code> depends on both <code>Time horizon (h)</code> and <code>Time step (min)</code>, as the table below illustrates.</p><table><tr><th style="text-align: center">Time horizon (h)</th><th style="text-align: center">Time step (min)</th><th style="text-align: center">T</th></tr><tr><td style="text-align: center">24</td><td style="text-align: center">60</td><td style="text-align: center">24</td></tr><tr><td style="text-align: center">24</td><td style="text-align: center">15</td><td style="text-align: center">96</td></tr><tr><td style="text-align: center">24</td><td style="text-align: center">5</td><td style="text-align: center">288</td></tr><tr><td style="text-align: center">36</td><td style="text-align: center">60</td><td style="text-align: center">36</td></tr><tr><td style="text-align: center">36</td><td style="text-align: center">15</td><td style="text-align: center">144</td></tr><tr><td style="text-align: center">36</td><td style="text-align: center">5</td><td style="text-align: center">432</td></tr></table><h2 id="Output-Data-Format"><a class="docs-heading-anchor" href="#Output-Data-Format">Output Data Format</a><a id="Output-Data-Format-1"></a><a class="docs-heading-anchor-permalink" href="#Output-Data-Format" title="Permalink"></a></h2><p>The output data format is also JSON-based, but it is not currently documented since we expect it to change significantly in a future version of the package.</p><h2 id="Current-limitations"><a class="docs-heading-anchor" href="#Current-limitations">Current limitations</a><a id="Current-limitations-1"></a><a class="docs-heading-anchor-permalink" href="#Current-limitations" title="Permalink"></a></h2><ul><li>Network topology remains the same for all time periods</li><li>Only N-1 transmission contingencies are supported. Generator contingencies are not currently supported.</li><li>Time-varying minimum production amounts are not currently compatible with ramp/startup/shutdown limits.</li><li>Flexible ramping products can only be acquired under the <code>WanHob2016</code> formulation, which does not support spinning reserves. </li></ul></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../usage/">« Usage</a><a class="docs-footer-nextpage" href="../instances/">Instances »</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.21 on <span class="colophon-date" title="Sunday 17 July 2022 14:42">Sunday 17 July 2022</span>. Using Julia version 1.7.3.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
}</code></pre><p>The value <code>T</code> depends on both <code>Time horizon (h)</code> and <code>Time step (min)</code>, as the table below illustrates.</p><table><tr><th style="text-align: center">Time horizon (h)</th><th style="text-align: center">Time step (min)</th><th style="text-align: center">T</th></tr><tr><td style="text-align: center">24</td><td style="text-align: center">60</td><td style="text-align: center">24</td></tr><tr><td style="text-align: center">24</td><td style="text-align: center">15</td><td style="text-align: center">96</td></tr><tr><td style="text-align: center">24</td><td style="text-align: center">5</td><td style="text-align: center">288</td></tr><tr><td style="text-align: center">36</td><td style="text-align: center">60</td><td style="text-align: center">36</td></tr><tr><td style="text-align: center">36</td><td style="text-align: center">15</td><td style="text-align: center">144</td></tr><tr><td style="text-align: center">36</td><td style="text-align: center">5</td><td style="text-align: center">432</td></tr></table><h2 id="Output-Data-Format"><a class="docs-heading-anchor" href="#Output-Data-Format">Output Data Format</a><a id="Output-Data-Format-1"></a><a class="docs-heading-anchor-permalink" href="#Output-Data-Format" title="Permalink"></a></h2><p>The output data format is also JSON-based, but it is not currently documented since we expect it to change significantly in a future version of the package.</p><h2 id="Current-limitations"><a class="docs-heading-anchor" href="#Current-limitations">Current limitations</a><a id="Current-limitations-1"></a><a class="docs-heading-anchor-permalink" href="#Current-limitations" title="Permalink"></a></h2><ul><li>Network topology remains the same for all time periods</li><li>Only N-1 transmission contingencies are supported. Generator contingencies are not currently supported.</li><li>Time-varying minimum production amounts are not currently compatible with ramp/startup/shutdown limits.</li><li>Flexible ramping products can only be acquired under the <code>WanHob2016</code> formulation, which does not support spinning reserves. </li></ul></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../usage/">« Usage</a><a class="docs-footer-nextpage" href="../instances/">Instances »</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.21 on <span class="colophon-date" title="Sunday 17 July 2022 15:54">Sunday 17 July 2022</span>. Using Julia version 1.7.3.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>