build based on ed59699

dev/.documenter-siteinfo.json

@@ -1 +1 @@
-{"documenter":{"julia_version":"1.10.5","generation_timestamp":"2024-09-23T20:02:25","documenter_version":"1.7.0"}}
+{"documenter":{"julia_version":"1.10.5","generation_timestamp":"2024-09-23T20:19:31","documenter_version":"1.7.0"}}

dev/installation.html

@@ -3,4 +3,4 @@
 Pkg.add(&quot;PowerModelsONM&quot;)</code></pre><h2 id="Developer-Installation"><a class="docs-heading-anchor" href="#Developer-Installation">Developer Installation</a><a id="Developer-Installation-1"></a><a class="docs-heading-anchor-permalink" href="#Developer-Installation" title="Permalink"></a></h2><p>To install PowerModelsONM as a developer,</p><pre><code class="language-julia hljs">import Pkg
 Pkg.develop(Pkg.PackageSpec(; name=&quot;PowerModelsONM&quot;, url=&quot;https://github.com/lanl-ansi/PowerModelsONM.jl&quot;))</code></pre><p>From the command-line, outside Julia, one could download the repository, either via Github.com, or using git, <em>i.e.</em>,</p><pre><code class="language-sh hljs">git clone https://github.com/lanl-ansi/PowerModelsONM.jl.git
 git checkout tags/v1.0.0</code></pre><p>Then to install PowerModelsONM and its required packages</p><pre><code class="language-sh hljs">julia --project=&quot;path/to/PowerModelsONM&quot; -e &#39;using Pkg; Pkg.instantiate(); Pkg.precompile();&#39;</code></pre><h2 id="Gurobi-Configuration"><a class="docs-heading-anchor" href="#Gurobi-Configuration">Gurobi Configuration</a><a id="Gurobi-Configuration-1"></a><a class="docs-heading-anchor-permalink" href="#Gurobi-Configuration" title="Permalink"></a></h2><p>To use Gurobi, a Gurobi binary in required on your system, as well as ENV variables defining where the Gurobi binary is, and where your Gurobi license file is, <em>e.g.</em>, for Gurobi 9.10 on MacOS,</p><pre><code class="language-sh hljs">export GRB_LICENSE_FILE=&quot;$HOME/.gurobi/gurobi.lic&quot;
-export GUROBI_HOME=&quot;/Library/gurobi910/mac64&quot;</code></pre><p><strong>BEFORE</strong> importing PowerModelsONM with <code>using PowerModelsONM</code>, you <strong>must</strong> <code>import Gurobi</code>.</p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="index.html">« Introduction</a><a class="docs-footer-nextpage" href="manual/quickguide.html">Getting Started »</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="Monday 23 September 2024 20:02">Monday 23 September 2024</span>. Using Julia version 1.10.5.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
+export GUROBI_HOME=&quot;/Library/gurobi910/mac64&quot;</code></pre><p><strong>BEFORE</strong> importing PowerModelsONM with <code>using PowerModelsONM</code>, you <strong>must</strong> <code>import Gurobi</code>.</p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="index.html">« Introduction</a><a class="docs-footer-nextpage" href="manual/quickguide.html">Getting Started »</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="Monday 23 September 2024 20:19">Monday 23 September 2024</span>. Using Julia version 1.10.5.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>

dev/manual/graphml_export.html

@@ -5,4 +5,4 @@
 save_graphml(&quot;unnested_ieee13.graphml&quot;, eng; type=&quot;unnested&quot;)</code></pre><p>Below is what this exported graphml looks like after being loaded in yEd, the ONM recommended properaties applied, and the Orthogonal - Classic layout applied.</p><p><img src="../assets/unnested_ieee13.svg" alt="Unnested IEEE13 Graph"/></p><h2 id="Nested-Graph"><a class="docs-heading-anchor" href="#Nested-Graph">Nested Graph</a><a id="Nested-Graph-1"></a><a class="docs-heading-anchor-permalink" href="#Nested-Graph" title="Permalink"></a></h2><p>To export an nested graph</p><pre><code class="language-julia hljs">import PowerModelsONM as ONM
 onm_path = joinpath(dirname(pathof(ONM)), &quot;../examples/data&quot;)
 eng = ONM.PMD.parse_file(joinpath(onm_path, &quot;network.ieee13.dss&quot;))
-save_graphml(&quot;nested_ieee13.graphml&quot;, eng; type=&quot;nested&quot;)</code></pre><p>Below is what this exported graphml looks like after being loaded in yEd, the ONM recommended properaties applied, and the Orthogonal - Classic layout applied.</p><p><img src="../assets/nested_ieee13.svg" alt="Nested IEEE13 Graph"/></p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="opf_model.html">« Optimal Dispatch Mathematical Model</a><a class="docs-footer-nextpage" href="../tutorials/Beginners Guide.html">Beginners Guide »</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="Monday 23 September 2024 20:02">Monday 23 September 2024</span>. Using Julia version 1.10.5.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
+save_graphml(&quot;nested_ieee13.graphml&quot;, eng; type=&quot;nested&quot;)</code></pre><p>Below is what this exported graphml looks like after being loaded in yEd, the ONM recommended properaties applied, and the Orthogonal - Classic layout applied.</p><p><img src="../assets/nested_ieee13.svg" alt="Nested IEEE13 Graph"/></p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="opf_model.html">« Optimal Dispatch Mathematical Model</a><a class="docs-footer-nextpage" href="../tutorials/Beginners Guide.html">Beginners Guide »</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="Monday 23 September 2024 20:19">Monday 23 September 2024</span>. Using Julia version 1.10.5.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>

dev/manual/mld_model.html

@@ -32,4 +32,4 @@
 & S^{sw}_i \geq -S^{swu} z^{sw}_i\ \forall i \in S \\
 & V^{fr}_{i,c} - V^{to}_{i,c} \leq v^u_{i,c} \left ( 1 - z^{sw}_i \right )\ \forall i \in S,\forall c \in C \\
 & V^{fr}_{i,c} - V^{to}_{i,c} \geq -v^u_{i,c} \left ( 1 - z^{sw}_i \right )\ \forall i \in S,\forall c \in C
-\end{align}\]</p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="onm_workflow.html">« The ONM Workflow</a><a class="docs-footer-nextpage" href="opf_model.html">Optimal Dispatch Mathematical Model »</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="Monday 23 September 2024 20:02">Monday 23 September 2024</span>. Using Julia version 1.10.5.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
+\end{align}\]</p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="onm_workflow.html">« The ONM Workflow</a><a class="docs-footer-nextpage" href="opf_model.html">Optimal Dispatch Mathematical Model »</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="Monday 23 September 2024 20:19">Monday 23 September 2024</span>. Using Julia version 1.10.5.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>

dev/manual/opf_model.html

@@ -33,4 +33,4 @@
 & \mathbf{S}_{ji} = \mathbf{V}_j \mathbf{V}_j^H \left( \mathbf{Y}_{ij} + \mathbf{Y}^c_{ji} \right)^H - {\mathbf{V}^H_i \mathbf{V}_j} \mathbf{Y}^H_{ij} \;\; \forall (i,j)\in E \\
 & |diag(\mathbf{S}_{ij})| \leq \mathbf{s}^u_{ij} \;\; \forall (i,j) \in E \cup E^R \\
 & \theta^{\Delta l}_{ij,c} \leq \angle (V_{i,c} V^*_{j,c}) \leq \theta^{\Delta u}_{ij,c} \;\; \forall (i,j) \in E, \forall c \in C
-\end{align}\]</p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="mld_model.html">« Optimal Switch / Load shed Mathematical Model</a><a class="docs-footer-nextpage" href="graphml_export.html">Exporting with GraphML »</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="Monday 23 September 2024 20:02">Monday 23 September 2024</span>. Using Julia version 1.10.5.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
+\end{align}\]</p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="mld_model.html">« Optimal Switch / Load shed Mathematical Model</a><a class="docs-footer-nextpage" href="graphml_export.html">Exporting with GraphML »</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="Monday 23 September 2024 20:19">Monday 23 September 2024</span>. Using Julia version 1.10.5.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>