mirror of
https://github.com/ANL-CEEESA/UnitCommitment.jl.git
synced 2025-12-06 00:08:52 -06:00
Update docs
This commit is contained in:
@@ -66,4 +66,4 @@ UnitCommitment.optimize!(model, ph)
|
||||
solution = UnitCommitment.solution(model, ph)
|
||||
|
||||
# 7. Close MPI
|
||||
MPI.Finalize()</code></pre><p>When using PH, the model can be customized as usual, with different formulations or additional user-provided constraints. Note that <code>read</code>, in this case, takes <code>ph</code> as an argument. This allows each Julia process to read only the instance files that are relevant to it. Similarly, the <code>solution</code> function gathers the optimal solution of each processes and returns a combined dictionary.</p><p>Each process solves a sub-problem with <span>$\frac{s}{p}$</span> scenarios, where <span>$s$</span> is the total number of scenarios and <span>$p$</span> is the number of MPI processes. For instance, if we have 15 scenario files and 5 processes, then each process will solve a JuMP model that contains data for 3 scenarios. If the total number of scenarios is not divisible by the number of processes, then an error will be thrown.</p><div class="admonition is-warning"><header class="admonition-header">Warning</header><div class="admonition-body"><p>Currently, PH can handle only equiprobable scenarios. Further, <code>solution(model, ph)</code> can only handle cases where only one scenario is modeled in each process.</p></div></div></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../market/">« Market Clearing</a><a class="docs-footer-nextpage" href="../../guides/problem/">Problem definition »</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 21 May 2024 10:39">Tuesday 21 May 2024</span>. Using Julia version 1.10.3.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
|
||||
MPI.Finalize()</code></pre><p>When using PH, the model can be customized as usual, with different formulations or additional user-provided constraints. Note that <code>read</code>, in this case, takes <code>ph</code> as an argument. This allows each Julia process to read only the instance files that are relevant to it. Similarly, the <code>solution</code> function gathers the optimal solution of each processes and returns a combined dictionary.</p><p>Each process solves a sub-problem with <span>$\frac{s}{p}$</span> scenarios, where <span>$s$</span> is the total number of scenarios and <span>$p$</span> is the number of MPI processes. For instance, if we have 15 scenario files and 5 processes, then each process will solve a JuMP model that contains data for 3 scenarios. If the total number of scenarios is not divisible by the number of processes, then an error will be thrown.</p><div class="admonition is-warning"><header class="admonition-header">Warning</header><div class="admonition-body"><p>Currently, PH can handle only equiprobable scenarios. Further, <code>solution(model, ph)</code> can only handle cases where only one scenario is modeled in each process.</p></div></div></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../market/">« Market Clearing</a><a class="docs-footer-nextpage" href="../../guides/problem/">Problem definition »</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 21 May 2024 10:56">Tuesday 21 May 2024</span>. Using Julia version 1.10.3.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
|
||||
|
||||
Reference in New Issue
Block a user