build based on 9c25674

dev/.documenter-siteinfo.json

@@ -1 +1 @@
-{"documenter":{"julia_version":"1.8.5","generation_timestamp":"2023-12-21T13:12:45","documenter_version":"1.2.1"}}
+{"documenter":{"julia_version":"1.8.5","generation_timestamp":"2023-12-26T10:33:41","documenter_version":"1.2.1"}}

dev/api/stateEstimation/index.html

@@ -10,11 +10,11 @@
 system = powerSystem("case14.h5")
 device = measurement("measurement14.h5")
 
-analysis = dcStateEstimation(system, device, Ipopt.Optimizer)</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/mcosovic/JuliaGrid.jl/blob/fca26b99bbd6d164198481eefda24c80da2ec3f0/src/stateEstimation/dcStateEstimation.jl#L1-L67">source</a></section></article><hr/><h2 id="Solve-DC-State-Estimation-2"><a class="docs-heading-anchor" href="#Solve-DC-State-Estimation-2">Solve DC State Estimation</a><a class="docs-heading-anchor-permalink" href="#Solve-DC-State-Estimation-2" title="Permalink"></a></h2><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="JuliaGrid.solve!-Tuple{PowerSystem, DCStateEstimationWLS}" href="#JuliaGrid.solve!-Tuple{PowerSystem, DCStateEstimationWLS}"><code>JuliaGrid.solve!</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">solve!(system::PowerSystem, analysis::DCStateEstimation)</code></pre><p>By computing the bus voltage angles, the function solves the DC state estimation problem.</p><p><strong>Updates</strong></p><p>The resulting bus voltage angles are stored in the <code>voltage</code> field of the <code>DCStateEstimation</code>  type.</p><p><strong>Example</strong></p><pre><code class="language-julia hljs">system = powerSystem(&quot;case14.h5&quot;)
+analysis = dcStateEstimation(system, device, Ipopt.Optimizer)</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/mcosovic/JuliaGrid.jl/blob/9c25674e8e23f15279472c2ac85fae7113e0f6eb/src/stateEstimation/dcStateEstimation.jl#L1-L67">source</a></section></article><hr/><h2 id="Solve-DC-State-Estimation-2"><a class="docs-heading-anchor" href="#Solve-DC-State-Estimation-2">Solve DC State Estimation</a><a class="docs-heading-anchor-permalink" href="#Solve-DC-State-Estimation-2" title="Permalink"></a></h2><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="JuliaGrid.solve!-Tuple{PowerSystem, DCStateEstimationWLS}" href="#JuliaGrid.solve!-Tuple{PowerSystem, DCStateEstimationWLS}"><code>JuliaGrid.solve!</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">solve!(system::PowerSystem, analysis::DCStateEstimation)</code></pre><p>By computing the bus voltage angles, the function solves the DC state estimation problem.</p><p><strong>Updates</strong></p><p>The resulting bus voltage angles are stored in the <code>voltage</code> field of the <code>DCStateEstimation</code>  type.</p><p><strong>Example</strong></p><pre><code class="language-julia hljs">system = powerSystem(&quot;case14.h5&quot;)
 device = measurement(&quot;measurement14.h5&quot;)
 
 analysis = dcStateEstimation(system, device)
-solve!(system, analysis)</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/mcosovic/JuliaGrid.jl/blob/fca26b99bbd6d164198481eefda24c80da2ec3f0/src/stateEstimation/dcStateEstimation.jl#L186-L203">source</a></section></article><hr/><h2 id="Bad-Data-Analysis-2"><a class="docs-heading-anchor" href="#Bad-Data-Analysis-2">Bad Data Analysis</a><a class="docs-heading-anchor-permalink" href="#Bad-Data-Analysis-2" title="Permalink"></a></h2><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="JuliaGrid.badData!" href="#JuliaGrid.badData!"><code>JuliaGrid.badData!</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia hljs">badData!(system::PowerSystem, device::Measurement, analysis::DCStateEstimation; threshold)</code></pre><p>The function conducts bad data detection and identification using the largest normalized  residual test, subsequently removing measurement outliers from the measurement set. It can  be executed after obtaining estimation solutions.</p><p><strong>Arguments</strong></p><p>This function necessitates the composite types <code>PowerSystem</code>, <code>Measurement</code>, and  <code>DCStateEstimation</code> to detect and identify bad data.</p><p><strong>Keyword</strong></p><p>The keyword <code>threshold</code> establishes the identification threshold. If the largest  normalized residual surpasses this threshold, the measurement is flagged as bad data. The  default threshold value is set to <code>threshold = 3.0</code>.</p><p><strong>Updates</strong></p><p>In case bad data is detected, the function removes measurements from the <code>jacobian</code> matrix,  <code>weight</code>, and <code>mean</code> vectors within the <code>DCStateEstimation</code> type. Additionally, it marks  the respective measurement within the <code>Measurement</code> type as out-of-service.</p><p>Furthermore, the variable <code>bad</code> within the <code>DCStateEstimation</code> type stores information  regarding bad data detection and identification:</p><ul><li><code>detect</code>: returns <code>true</code> after the function&#39;s execution if bad data is detected;</li><li><code>maxNormalizedResidual</code>: denotes the value of the largest normalized residual;</li><li><code>index</code>: represents the index of the bad data associated with the <code>DCStateEstimation</code> type;</li><li><code>label</code>: signifies the label of the bad data.</li></ul><p><strong>Example</strong></p><p>Obtaining the solution after detecting and removing bad data:</p><pre><code class="language-julia hljs">system = powerSystem(&quot;case14.h5&quot;)
+solve!(system, analysis)</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/mcosovic/JuliaGrid.jl/blob/9c25674e8e23f15279472c2ac85fae7113e0f6eb/src/stateEstimation/dcStateEstimation.jl#L275-L292">source</a></section></article><hr/><h2 id="Bad-Data-Analysis-2"><a class="docs-heading-anchor" href="#Bad-Data-Analysis-2">Bad Data Analysis</a><a class="docs-heading-anchor-permalink" href="#Bad-Data-Analysis-2" title="Permalink"></a></h2><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="JuliaGrid.badData!" href="#JuliaGrid.badData!"><code>JuliaGrid.badData!</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia hljs">badData!(system::PowerSystem, device::Measurement, analysis::DCStateEstimation; threshold)</code></pre><p>The function conducts bad data detection and identification using the largest normalized  residual test, subsequently removing measurement outliers from the measurement set. It can  be executed after obtaining estimation solutions.</p><p><strong>Arguments</strong></p><p>This function necessitates the composite types <code>PowerSystem</code>, <code>Measurement</code>, and  <code>DCStateEstimation</code> to detect and identify bad data.</p><p><strong>Keyword</strong></p><p>The keyword <code>threshold</code> establishes the identification threshold. If the largest  normalized residual surpasses this threshold, the measurement is flagged as bad data. The  default threshold value is set to <code>threshold = 3.0</code>.</p><p><strong>Updates</strong></p><p>In case bad data is detected, the function removes measurements from the <code>jacobian</code> matrix,  <code>weight</code>, and <code>mean</code> vectors within the <code>DCStateEstimation</code> type. Additionally, it marks  the respective measurement within the <code>Measurement</code> type as out-of-service.</p><p>Furthermore, the variable <code>bad</code> within the <code>DCStateEstimation</code> type stores information  regarding bad data detection and identification:</p><ul><li><code>detect</code>: returns <code>true</code> after the function&#39;s execution if bad data is detected;</li><li><code>maxNormalizedResidual</code>: denotes the value of the largest normalized residual;</li><li><code>index</code>: represents the index of the bad data associated with the <code>DCStateEstimation</code> type;</li><li><code>label</code>: signifies the label of the bad data.</li></ul><p><strong>Example</strong></p><p>Obtaining the solution after detecting and removing bad data:</p><pre><code class="language-julia hljs">system = powerSystem(&quot;case14.h5&quot;)
 device = measurement(&quot;measurement14.h5&quot;)
 
 analysis = dcStateEstimation(system, device)
@@ -29,4 +29,4 @@
 while analysis.bad.detect
     solve!(system, analysis)
     badData!(system, device, analysis; threshold = 4.0)
-end</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/mcosovic/JuliaGrid.jl/blob/fca26b99bbd6d164198481eefda24c80da2ec3f0/src/stateEstimation/badData.jl#L1-L54">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../measurementModel/">« Measurement Model</a><a class="docs-footer-nextpage" href="../analysis/">Power and Current Analysis »</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><option value="auto">Automatic (OS)</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.2.1 on <span class="colophon-date" title="Thursday 21 December 2023 13:12">Thursday 21 December 2023</span>. Using Julia version 1.8.5.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
+end</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/mcosovic/JuliaGrid.jl/blob/9c25674e8e23f15279472c2ac85fae7113e0f6eb/src/stateEstimation/badData.jl#L1-L54">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../measurementModel/">« Measurement Model</a><a class="docs-footer-nextpage" href="../analysis/">Power and Current Analysis »</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><option value="auto">Automatic (OS)</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.2.1 on <span class="colophon-date" title="Tuesday 26 December 2023 10:33">Tuesday 26 December 2023</span>. Using Julia version 1.8.5.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>

dev/index.html

@@ -48,4 +48,4 @@
 
 updateBus!(system, analysis; label = 1, type = 1) # Modify the existing bus
 updateBus!(system, analysis; label = 2, type = 3) # Designate the new slack bus
-solve!(system, analysis)                          # Compute new solution in the updated setup</code></pre><hr/><h4 id="Contributors"><a class="docs-heading-anchor" href="#Contributors">Contributors</a><a id="Contributors-1"></a><a class="docs-heading-anchor-permalink" href="#Contributors" title="Permalink"></a></h4><ul><li><a href="https://www.linkedin.com/in/ognjen-kundacina-machine-learning-guy/">Ognjen Kundacina</a> - The Institute for Artificial Intelligence Research and Development of Serbia</li><li><a href="https://www.linkedin.com/in/muhameddelalic/">Muhamed Delalic</a> - University of Sarajevo, Bosnia and Herzegovina</li><li>Lin Zeng - Cornell University, Ithaca, NY, USA</li><li><a href="https://www.linkedin.com/in/mirsad-cosovic-5a4972a9/">Mirsad Cosovic</a> - University of Sarajevo, Bosnia and Herzegovina</li></ul></article><nav class="docs-footer"><a class="docs-footer-nextpage" href="manual/powerSystemModel/">Power System 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="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="auto">Automatic (OS)</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.2.1 on <span class="colophon-date" title="Thursday 21 December 2023 13:12">Thursday 21 December 2023</span>. Using Julia version 1.8.5.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
+solve!(system, analysis)                          # Compute new solution in the updated setup</code></pre><hr/><h4 id="Contributors"><a class="docs-heading-anchor" href="#Contributors">Contributors</a><a id="Contributors-1"></a><a class="docs-heading-anchor-permalink" href="#Contributors" title="Permalink"></a></h4><ul><li><a href="https://www.linkedin.com/in/ognjen-kundacina-machine-learning-guy/">Ognjen Kundacina</a> - The Institute for Artificial Intelligence Research and Development of Serbia</li><li><a href="https://www.linkedin.com/in/muhameddelalic/">Muhamed Delalic</a> - University of Sarajevo, Bosnia and Herzegovina</li><li>Lin Zeng - Cornell University, Ithaca, NY, USA</li><li><a href="https://www.linkedin.com/in/mirsad-cosovic-5a4972a9/">Mirsad Cosovic</a> - University of Sarajevo, Bosnia and Herzegovina</li></ul></article><nav class="docs-footer"><a class="docs-footer-nextpage" href="manual/powerSystemModel/">Power System 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="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="auto">Automatic (OS)</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.2.1 on <span class="colophon-date" title="Tuesday 26 December 2023 10:33">Tuesday 26 December 2023</span>. Using Julia version 1.8.5.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>