build based on 0239dfc

NREL-Sienna · Sep 23, 2024 · 5e1fa58 · 5e1fa58
1 parent bd5eb2e
commit 5e1fa58
Show file tree

Hide file tree

Showing 1,177 changed files with 322,802 additions and 15,564 deletions.
diff --git a/dev/api/internal/index.html b/dev/api/internal/index.html
diff --git a/dev/api/public/index.html b/dev/api/public/index.html
diff --git a/dev/assets/VirtualLODF_scheme.png b/dev/assets/VirtualLODF_scheme.png
diff --git a/dev/assets/VirtualPTDF_scheme.png b/dev/assets/VirtualPTDF_scheme.png
diff --git a/dev/assets/logo.png b/dev/assets/logo.png
diff --git a/dev/assets/themes/documenter-dark.css b/dev/assets/themes/documenter-dark.css
diff --git a/dev/assets/themes/documenter-light.css b/dev/assets/themes/documenter-light.css
diff --git a/dev/index.html b/dev/index.html
@@ -1,2 +1,2 @@
 <!DOCTYPE html>
-<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>Welcome Page · PowerNetworkMatrices.jl</title><script data-outdated-warner src="assets/warner.js"></script><link href="https://cdnjs.cloudflare.com/ajax/libs/lato-font/3.0.0/css/lato-font.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/juliamono/0.045/juliamono.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.4/css/fontawesome.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.4/css/solid.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.4/css/brands.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.13.24/katex.min.css" rel="stylesheet" type="text/css"/><script>documenterBaseURL="."</script><script src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.6/require.min.js" data-main="assets/documenter.js"></script><script src="siteinfo.js"></script><script src="../versions.js"></script><link class="docs-theme-link" rel="stylesheet" type="text/css" href="assets/themes/documenter-dark.css" data-theme-name="documenter-dark" data-theme-primary-dark/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="assets/themes/documenter-light.css" data-theme-name="documenter-light" data-theme-primary/><script src="assets/themeswap.js"></script></head><body><div id="documenter"><nav class="docs-sidebar"><div class="docs-package-name"><span class="docs-autofit"><a href>PowerNetworkMatrices.jl</a></span></div><form class="docs-search" action="search/"><input class="docs-search-query" id="documenter-search-query" name="q" type="text" placeholder="Search docs"/></form><ul class="docs-menu"><li class="is-active"><a class="tocitem" href>Welcome Page</a><ul class="internal"><li><a class="tocitem" href="#Overview"><span>Overview</span></a></li><li><a class="tocitem" href="#Installation"><span>Installation</span></a></li></ul></li><li><a class="tocitem" href="quick_start_guide/">Quick Start Guide</a></li><li><a class="tocitem" href="tutorials/intro_page/">Tutorials</a></li><li><a class="tocitem" href="api/public/">Public API Reference</a></li><li><a class="tocitem" href="api/internal/">Internal API Reference</a></li></ul><div class="docs-version-selector field has-addons"><div class="control"><span class="docs-label button is-static is-size-7">Version</span></div><div class="docs-selector control is-expanded"><div class="select is-fullwidth is-size-7"><select id="documenter-version-selector"></select></div></div></div></nav><div class="docs-main"><header class="docs-navbar"><nav class="breadcrumb"><ul class="is-hidden-mobile"><li class="is-active"><a href>Welcome Page</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>Welcome Page</a></li></ul></nav><div class="docs-right"><a class="docs-edit-link" href="https://github.com/NREL-SIIP/PowerNetworkMatrices.jl/blob/main/docs/src/index.md" title="Edit on GitHub"><span class="docs-icon fab"></span><span class="docs-label is-hidden-touch">Edit on GitHub</span></a><a class="docs-settings-button fas fa-cog" id="documenter-settings-button" href="#" title="Settings"></a><a class="docs-sidebar-button fa fa-bars is-hidden-desktop" id="documenter-sidebar-button" href="#"></a></div></header><article class="content" id="documenter-page"><h1 id="PowerNetworkMatrices.jl"><a class="docs-heading-anchor" href="#PowerNetworkMatrices.jl">PowerNetworkMatrices.jl</a><a id="PowerNetworkMatrices.jl-1"></a><a class="docs-heading-anchor-permalink" href="#PowerNetworkMatrices.jl" title="Permalink"></a></h1><h2 id="Overview"><a class="docs-heading-anchor" href="#Overview">Overview</a><a id="Overview-1"></a><a class="docs-heading-anchor-permalink" href="#Overview" title="Permalink"></a></h2><p><code>PowerNetworkMatrices.jl</code> documentation and code are organized according to the needs of different users depending on their skillset and requirements. In broad terms there are three categories:</p><ul><li><p><strong>Modeler</strong>: Users that want to run a particular analysis or experiment and use <code>PowerNetworkMatrices.jl</code> to develop data sets.</p></li><li><p><strong>Model Developer</strong>: Users that want to develop custom components and structs in order to exploit <code>PowerNetworkMatrices.jl</code> features to produce custom data sets.</p></li><li><p><strong>Code Base Developers</strong>: Users that want to add new core functionalities or fix bugs in the core capabilities of <code>PowerNetworkMatrices.jl</code>.</p></li></ul><p><code>PowerNetworkMatrices.jl</code> is an active project under development, and we welcome your feedback, suggestions, and bug reports.</p><h2 id="Installation"><a class="docs-heading-anchor" href="#Installation">Installation</a><a id="Installation-1"></a><a class="docs-heading-anchor-permalink" href="#Installation" title="Permalink"></a></h2><p>The latest stable release of PowerNetworkMatrices can be installed using the Julia package manager with</p><pre><code class="language-julia hljs">] add PowerNetworkMatrices</code></pre><p>For the current development version, &quot;checkout&quot; this package with</p><pre><code class="language-julia hljs">] add PowerNetworkMatrices#master</code></pre><hr/><p>PowerNetworkMatrices has been developed as part of the Scalable Integrated Infrastructure Planning (SIIP) initiative at 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-nextpage" href="quick_start_guide/">Quick Start 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="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.24 on <span class="colophon-date" title="Tuesday 28 March 2023 18:03">Tuesday 28 March 2023</span>. Using Julia version 1.6.7.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
+<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>Welcome Page · PowerNetworkMatrices.jl</title><script data-outdated-warner src="assets/warner.js"></script><link href="https://cdnjs.cloudflare.com/ajax/libs/lato-font/3.0.0/css/lato-font.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/juliamono/0.045/juliamono.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.4/css/fontawesome.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.4/css/solid.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.4/css/brands.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.13.24/katex.min.css" rel="stylesheet" type="text/css"/><script>documenterBaseURL="."</script><script src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.6/require.min.js" data-main="assets/documenter.js"></script><script src="siteinfo.js"></script><script src="../versions.js"></script><link class="docs-theme-link" rel="stylesheet" type="text/css" href="assets/themes/documenter-dark.css" data-theme-name="documenter-dark" data-theme-primary-dark/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="assets/themes/documenter-light.css" data-theme-name="documenter-light" data-theme-primary/><script src="assets/themeswap.js"></script></head><body><div id="documenter"><nav class="docs-sidebar"><a class="docs-logo" href><img src="assets/logo.png" alt="PowerNetworkMatrices.jl logo"/></a><div class="docs-package-name"><span class="docs-autofit"><a href>PowerNetworkMatrices.jl</a></span></div><form class="docs-search" action="search/"><input class="docs-search-query" id="documenter-search-query" name="q" type="text" placeholder="Search docs"/></form><ul class="docs-menu"><li class="is-active"><a class="tocitem" href>Welcome Page</a><ul class="internal"><li><a class="tocitem" href="#Overview"><span>Overview</span></a></li><li><a class="tocitem" href="#Installation"><span>Installation</span></a></li></ul></li><li><a class="tocitem" href="quick_start_guide/">Quick Start Guide</a></li><li><span class="tocitem">Tutorials</span><ul><li><a class="tocitem" href="tutorials/tutorial_Incidence_BA_ABA_matrices/">Incidence, BA and ABA matrices</a></li><li><a class="tocitem" href="tutorials/tutorial_PTDF_matrix/">PTDF matrix</a></li><li><a class="tocitem" href="tutorials/tutorial_VirtualPTDF_matrix/">VirtualPTDF matrix</a></li><li><a class="tocitem" href="tutorials/tutorial_LODF_matrix/">LODF matrix</a></li><li><a class="tocitem" href="tutorials/tutorial_VirtualLODF_matrix/">VirtualLODF matrix</a></li></ul></li><li><a class="tocitem" href="api/public/">Public API Reference</a></li><li><a class="tocitem" href="api/internal/">Internal API Reference</a></li></ul><div class="docs-version-selector field has-addons"><div class="control"><span class="docs-label button is-static is-size-7">Version</span></div><div class="docs-selector control is-expanded"><div class="select is-fullwidth is-size-7"><select id="documenter-version-selector"></select></div></div></div></nav><div class="docs-main"><header class="docs-navbar"><nav class="breadcrumb"><ul class="is-hidden-mobile"><li class="is-active"><a href>Welcome Page</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>Welcome Page</a></li></ul></nav><div class="docs-right"><a class="docs-edit-link" href="https://github.com/NREL-Sienna/PowerNetworkMatrices.jl/blob/main/docs/src/index.md" title="Edit on GitHub"><span class="docs-icon fab"></span><span class="docs-label is-hidden-touch">Edit on GitHub</span></a><a class="docs-settings-button fas fa-cog" id="documenter-settings-button" href="#" title="Settings"></a><a class="docs-sidebar-button fa fa-bars is-hidden-desktop" id="documenter-sidebar-button" href="#"></a></div></header><article class="content" id="documenter-page"><h1 id="PowerNetworkMatrices.jl"><a class="docs-heading-anchor" href="#PowerNetworkMatrices.jl">PowerNetworkMatrices.jl</a><a id="PowerNetworkMatrices.jl-1"></a><a class="docs-heading-anchor-permalink" href="#PowerNetworkMatrices.jl" title="Permalink"></a></h1><h2 id="Overview"><a class="docs-heading-anchor" href="#Overview">Overview</a><a id="Overview-1"></a><a class="docs-heading-anchor-permalink" href="#Overview" title="Permalink"></a></h2><p><code>PowerNetworkMatrices.jl</code> is a <a href="http://www.julialang.org"><code>Julia</code></a> package for the evaluation of network matrices given the system&#39;s data. The package allows to compute the matrices according to different methods, providing a flexible and powerful tool.</p><p>The documentation and code are organized according to the needs of different users depending on their skillset and requirements. In broad terms there are three categories:</p><ul><li><p><strong>Modeler</strong>: Users that want to run a particular analysis or experiment and use <code>PowerNetworkMatrices.jl</code> to develop data sets.</p></li><li><p><strong>Model Developer</strong>: Users that want to develop custom components and structs in order to exploit <code>PowerNetworkMatrices.jl</code> features to produce custom data sets.</p></li><li><p><strong>Code Base Developers</strong>: Users that want to add new core functionalities or fix bugs in the core capabilities of <code>PowerNetworkMatrices.jl</code>.</p></li></ul><p><code>PowerNetworkMatrices.jl</code> is an active project under development, and we welcome your feedback, suggestions, and bug reports.</p><h2 id="Installation"><a class="docs-heading-anchor" href="#Installation">Installation</a><a id="Installation-1"></a><a class="docs-heading-anchor-permalink" href="#Installation" title="Permalink"></a></h2><p>The latest stable release of PowerNetworkMatrices can be installed using the Julia package manager with</p><pre><code class="language-julia hljs">] add PowerNetworkMatrices</code></pre><p>For the current development version, &quot;checkout&quot; this package with</p><pre><code class="language-julia hljs">] add PowerNetworkMatrices#master</code></pre><hr/><p>PowerNetworkMatrices has been developed as part of the Scalable Integrated Infrastructure Planning (SIIP) initiative at 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-nextpage" href="quick_start_guide/">Quick Start 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="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="Monday 23 September 2024 18:20">Monday 23 September 2024</span>. Using Julia version 1.10.5.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
diff --git a/dev/network_matrices.jl b/dev/network_matrices.jl
@@ -11,7 +11,7 @@
 # names as indexes to facilitate exploration and analysis. Ybus is stored as an SparseMatrix
 # and the PTDF and LODF are stored as dense matrices. **Note*** Ybus is converted to a dense
 # matrix for printing in the REPL,
-# The network matrices code implements the Goderya algorithm to find islands.
+# The network matrices code implements the dfs algorithm to find islands.
 
 using PowerSystems
 const PSY = PowerSystems