Skip to content

Commit

Permalink
build based on 55b68d7
Browse files Browse the repository at this point in the history
  • Loading branch information
Documenter.jl committed Dec 11, 2023
1 parent f894bd0 commit 53c2973
Show file tree
Hide file tree
Showing 13 changed files with 24 additions and 24 deletions.
2 changes: 1 addition & 1 deletion dev/ch1_sec1_install/index.html
View file
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
<!DOCTYPE html>
<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>Installation · EGRIP.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="../">EGRIP.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><a class="tocitem" href="../">Home</a></li><li><span class="tocitem">Manual</span><ul><li class="is-active"><a class="tocitem" href>Installation</a></li><li><a class="tocitem" href="../ch1_sec2_tutorials/">Tutorials</a></li><li><a class="tocitem" href="../ch1_sec3_formulations/">Mathematical Model</a></li><li><a class="tocitem" href="../ch1_sec4_advanced_algorithm/">Advanced Algorithms</a></li></ul></li><li><span class="tocitem">Library</span><ul><li><a class="tocitem" href="../ch2_sec1_library_public/">Public Library</a></li><li><a class="tocitem" href="../ch2_sec2_library_internal/">Internal Library</a></li></ul></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><a class="is-disabled">Manual</a></li><li class="is-active"><a href>Installation</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>Installation</a></li></ul></nav><div class="docs-right"><a class="docs-edit-link" href="https://github.com/ANL-CEEESA/EGRIP.jl/blob/master/docs/src/ch1_sec1_install.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="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></h1><p>For now since <code>EGRIP.jl</code> has not been registered, we need to load the package locally by putting the following code at the beginning of your test script:</p><pre><code class="language-julia hljs">cd(@__DIR__)
push!(LOAD_PATH,&quot;../src/&quot;)</code></pre></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../">« Home</a><a class="docs-footer-nextpage" href="../ch1_sec2_tutorials/">Tutorials »</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="Tuesday 26 September 2023 19:35">Tuesday 26 September 2023</span>. Using Julia version 1.9.3.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
push!(LOAD_PATH,&quot;../src/&quot;)</code></pre></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../">« Home</a><a class="docs-footer-nextpage" href="../ch1_sec2_tutorials/">Tutorials »</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 11 December 2023 07:57">Monday 11 December 2023</span>. Using Julia version 1.9.4.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
2 changes: 1 addition & 1 deletion dev/ch1_sec2_tutorials/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -25,4 +25,4 @@
t_final = parse(Int64, ARGS[4])
t_step = parse(Int64, ARGS[5])
gap = parse(Float64, ARGS[6])
solve_restoration(dir_case_network, dir_case_blackstart, dir_case_result, t_final, t_step, gap)</code></pre><p>Open <code>Terminal</code> and navigate to the directory containing <code>solve_bs.jl</code>.</p><pre><code class="nohighlight hljs">$ cd /path to solve_bs/</code></pre><p>Execute the following command:</p><pre><code class="nohighlight hljs">$ julia solve_bs.jl &#39;case39.m&#39; &#39;BS_generator.csv&#39; &#39;results/&#39; 300 100 0.15</code></pre><h2 id="Restoration-Plan-Verification"><a class="docs-heading-anchor" href="#Restoration-Plan-Verification">Restoration Plan Verification</a><a id="Restoration-Plan-Verification-1"></a><a class="docs-heading-anchor-permalink" href="#Restoration-Plan-Verification" title="Permalink"></a></h2><h3 id="Restoration-Plan-File-Generation"><a class="docs-heading-anchor" href="#Restoration-Plan-File-Generation">Restoration Plan File Generation</a><a id="Restoration-Plan-File-Generation-1"></a><a class="docs-heading-anchor-permalink" href="#Restoration-Plan-File-Generation" title="Permalink"></a></h3><p>This process consists of two steps. The first step is to generate restoration plan file (an event list) using the function <code>generateRestorationPlanFromOpt</code>. We need the following inputs:</p><ul><li><code>optResPath</code>: The path containing the optimized restoration plan result</li><li><code>outFileName</code>: the name of the restoration plan file to be generated</li><li><code>dataFile</code>: The name of the associated system data file (PSAT format, .m)</li><li><code>dataPath</code> (optional): the path of the datafile</li><li><code>Options</code> (optional): extra options</li></ul><p>The function will output <code>exitflag</code>, which 1 means success and fail otherwise. The function can be called using the following command:</p><pre><code class="nohighlight hljs">generateRestorationPlanFromOpt(&#39;D:\Box Sync\Blackstart_data\Blackstart_data\&#39;,&#39;restoration_plan_test_039.m&#39;,&#39;d_datane_39_mod_PQ_3&#39;)</code></pre><h3 id="Simulation"><a class="docs-heading-anchor" href="#Simulation">Simulation</a><a id="Simulation-1"></a><a class="docs-heading-anchor-permalink" href="#Simulation" title="Permalink"></a></h3><p>Once the event list is generated, we can run the simulation using the function <code>runDynamicSimulation</code>. We need the following inputs:</p><ul><li><code>dataFile</code>: The name of the associated system data file (PSAT format, .m)</li><li><code>restSettingFile</code>: the name of the restoration plan file</li><li><code>dataPath</code> (optional): the path of the datafile</li><li><code>Options</code> (optional): extra options</li></ul><p>There will be two outpus:</p><ul><li><code>exitflag</code>=1: run the whole simulation, otherwise: DSA did not finish all the simulation</li><li><code>msg</code>: detailed message</li></ul><p>The function can be called using the following command:</p><pre><code class="nohighlight hljs">[flag,msg]=runDynamicSimulation(&#39;d_datane_39_mod_PQ_3&#39;,&#39;restoration_plan_test_039&#39;)</code></pre><h3 id="Plots"><a class="docs-heading-anchor" href="#Plots">Plots</a><a id="Plots-1"></a><a class="docs-heading-anchor-permalink" href="#Plots" title="Permalink"></a></h3><p>Once the simulation is completed, we could load the simulation data:</p><pre><code class="nohighlight hljs">Load the *_simp.mat result file (located in ./restoration/)</code></pre><p>and plot the results:</p><pre><code class="nohighlight hljs">plotCurves(1,t,stateCurve,SysDataBase,’variableName’)</code></pre><p>The results of the IEEE 39-bus system are shown below. <img src="../fig_sas_res.png" alt="Enhanced Extended-Term Simulation"/> <img src="../fig_sas_res_1.png" alt="Enhanced Extended-Term Simulation"/></p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../ch1_sec1_install/">« Installation</a><a class="docs-footer-nextpage" href="../ch1_sec3_formulations/">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="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="Tuesday 26 September 2023 19:35">Tuesday 26 September 2023</span>. Using Julia version 1.9.3.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
solve_restoration(dir_case_network, dir_case_blackstart, dir_case_result, t_final, t_step, gap)</code></pre><p>Open <code>Terminal</code> and navigate to the directory containing <code>solve_bs.jl</code>.</p><pre><code class="nohighlight hljs">$ cd /path to solve_bs/</code></pre><p>Execute the following command:</p><pre><code class="nohighlight hljs">$ julia solve_bs.jl &#39;case39.m&#39; &#39;BS_generator.csv&#39; &#39;results/&#39; 300 100 0.15</code></pre><h2 id="Restoration-Plan-Verification"><a class="docs-heading-anchor" href="#Restoration-Plan-Verification">Restoration Plan Verification</a><a id="Restoration-Plan-Verification-1"></a><a class="docs-heading-anchor-permalink" href="#Restoration-Plan-Verification" title="Permalink"></a></h2><h3 id="Restoration-Plan-File-Generation"><a class="docs-heading-anchor" href="#Restoration-Plan-File-Generation">Restoration Plan File Generation</a><a id="Restoration-Plan-File-Generation-1"></a><a class="docs-heading-anchor-permalink" href="#Restoration-Plan-File-Generation" title="Permalink"></a></h3><p>This process consists of two steps. The first step is to generate restoration plan file (an event list) using the function <code>generateRestorationPlanFromOpt</code>. We need the following inputs:</p><ul><li><code>optResPath</code>: The path containing the optimized restoration plan result</li><li><code>outFileName</code>: the name of the restoration plan file to be generated</li><li><code>dataFile</code>: The name of the associated system data file (PSAT format, .m)</li><li><code>dataPath</code> (optional): the path of the datafile</li><li><code>Options</code> (optional): extra options</li></ul><p>The function will output <code>exitflag</code>, which 1 means success and fail otherwise. The function can be called using the following command:</p><pre><code class="nohighlight hljs">generateRestorationPlanFromOpt(&#39;D:\Box Sync\Blackstart_data\Blackstart_data\&#39;,&#39;restoration_plan_test_039.m&#39;,&#39;d_datane_39_mod_PQ_3&#39;)</code></pre><h3 id="Simulation"><a class="docs-heading-anchor" href="#Simulation">Simulation</a><a id="Simulation-1"></a><a class="docs-heading-anchor-permalink" href="#Simulation" title="Permalink"></a></h3><p>Once the event list is generated, we can run the simulation using the function <code>runDynamicSimulation</code>. We need the following inputs:</p><ul><li><code>dataFile</code>: The name of the associated system data file (PSAT format, .m)</li><li><code>restSettingFile</code>: the name of the restoration plan file</li><li><code>dataPath</code> (optional): the path of the datafile</li><li><code>Options</code> (optional): extra options</li></ul><p>There will be two outpus:</p><ul><li><code>exitflag</code>=1: run the whole simulation, otherwise: DSA did not finish all the simulation</li><li><code>msg</code>: detailed message</li></ul><p>The function can be called using the following command:</p><pre><code class="nohighlight hljs">[flag,msg]=runDynamicSimulation(&#39;d_datane_39_mod_PQ_3&#39;,&#39;restoration_plan_test_039&#39;)</code></pre><h3 id="Plots"><a class="docs-heading-anchor" href="#Plots">Plots</a><a id="Plots-1"></a><a class="docs-heading-anchor-permalink" href="#Plots" title="Permalink"></a></h3><p>Once the simulation is completed, we could load the simulation data:</p><pre><code class="nohighlight hljs">Load the *_simp.mat result file (located in ./restoration/)</code></pre><p>and plot the results:</p><pre><code class="nohighlight hljs">plotCurves(1,t,stateCurve,SysDataBase,’variableName’)</code></pre><p>The results of the IEEE 39-bus system are shown below. <img src="../fig_sas_res.png" alt="Enhanced Extended-Term Simulation"/> <img src="../fig_sas_res_1.png" alt="Enhanced Extended-Term Simulation"/></p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../ch1_sec1_install/">« Installation</a><a class="docs-footer-nextpage" href="../ch1_sec3_formulations/">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="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 11 December 2023 07:57">Monday 11 December 2023</span>. Using Julia version 1.9.4.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
2 changes: 1 addition & 1 deletion dev/ch1_sec3_formulations/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -195,4 +195,4 @@
\end{aligned}
\end{align*}\]</p><h4 id="Objective-3"><a class="docs-heading-anchor" href="#Objective-3">Objective</a><a class="docs-heading-anchor-permalink" href="#Objective-3" title="Permalink"></a></h4><p class="math-container">\[\begin{align*}
\min \sum_{g \in G}x_{g}+\sum_{d \in D}x_{d}
\end{align*}\]</p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../ch1_sec2_tutorials/">« Tutorials</a><a class="docs-footer-nextpage" href="../ch1_sec4_advanced_algorithm/">Advanced Algorithms »</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="Tuesday 26 September 2023 19:35">Tuesday 26 September 2023</span>. Using Julia version 1.9.3.</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="../ch1_sec2_tutorials/">« Tutorials</a><a class="docs-footer-nextpage" href="../ch1_sec4_advanced_algorithm/">Advanced Algorithms »</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 11 December 2023 07:57">Monday 11 December 2023</span>. Using Julia version 1.9.4.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
Loading

0 comments on commit 53c2973

Please sign in to comment.