ANL-CEEESA/UnitCommitment.jl
1
0
Fork 0
mirror of https://github.com/ANL-CEEESA/UnitCommitment.jl.git synced 2025-12-06 16:28:51 -06:00
Code Issues Packages Projects Releases Wiki Activity

Update docs

Browse Source
This commit is contained in:
Alinson S. Xavier
2020-11-06 13:44:17 -06:00
parent 712742a518
commit 100c4267e4
9 changed files with 129 additions and 605 deletions
Download Patch File Download Diff File Expand all files Collapse all files

87
0.1/usage/index.html
View File

@@ -116,13 +116,25 @@
<div class="col-md-3"><div class="bs-sidebar hidden-print affix well" role="complementary">
<ul class="nav bs-sidenav">
<li class="first-level active"><a href="#installation-guide">Installation Guide</a></li>
<li class="first-level active"><a href="#usage">Usage</a></li>
<li class="second-level"><a href="#1-installation">1. Installation</a></li>
<li class="second-level"><a href="#2-typical-usage">2. Typical Usage</a></li>
<li class="third-level"><a href="#21-solving-user-provided-instances">2.1 Solving user-provided instances</a></li>
<li class="third-level"><a href="#22-solving-benchmark-instances">2.2 Solving benchmark instances</a></li>
<li class="second-level"><a href="#3-advanced-usage">3. Advanced usage</a></li>
<li class="third-level"><a href="#31-modifying-the-formulation">3.1 Modifying the formulation</a></li>
<li class="third-level"><a href="#32-generating-initial-conditions">3.2 Generating initial conditions</a></li>
<li class="third-level"><a href="#33-verifying-solutions">3.3 Verifying solutions</a></li>
</ul>
</div></div>
<div class="col-md-9" role="main">
<h1 id="installation-guide">Installation Guide</h1>
<p>This package was tested and developed with <a href="https://julialang.org/">Julia 1.5</a>. To install Julia, please follow the <a href="https://julialang.org/downloads/platform.html">installation guide on their website</a>. To install <code>UnitCommitment.jl</code>, run the Julia interpreter, type <code>]</code> to open the package manager, then type:</p>
<h1 id="usage">Usage</h1>
<h2 id="1-installation">1. Installation</h2>
<p>UnitCommitment.jl was tested and developed with <a href="https://julialang.org/">Julia 1.5</a>. To install Julia, please follow the <a href="https://julialang.org/downloads/platform.html">installation guide on the official Julia website</a>. To install UnitCommitment.jl, run the Julia interpreter, type <code>]</code> to open the package manager, then type:</p>
<pre><code class="text">pkg&gt; add https://github.com/ANL-CEEESA/UnitCommitment.jl.git
</code></pre>
@@ -130,8 +142,73 @@
<pre><code class="text">pkg&gt; test UnitCommitment
</code></pre>
<p>If all tests pass, the package should now be ready to be used by any Julia script on the machine. To try it out in the julia interpreter hit <code>backspace</code> to return to the regular interpreter, and type the following command:</p>
<p>If all tests pass, the package should now be ready to be used by any Julia script on the machine.</p>
<p>To solve the optimization models, a mixed-integer linear programming (MILP) solver is also required. Please see the <a href="https://jump.dev/JuMP.jl/stable/installation/">JuMP installation guide</a> for more instructions on installing a solver. Typical open-source choices are <a href="https://github.com/JuliaOpt/Cbc.jl">Cbc</a> and <a href="https://github.com/JuliaOpt/GLPK.jl">GLPK</a>. In the instructions below, Cbc will be used, but any other MILP solver listed in JuMP installation guide should also be compatible.</p>
<h2 id="2-typical-usage">2. Typical Usage</h2>
<h3 id="21-solving-user-provided-instances">2.1 Solving user-provided instances</h3>
<p>The first step to use UC.jl is to construct a JSON file describing your unit commitment instance. See the <a href="">data format page</a> for a complete description of the data format UC.jl expects. The next steps, as shown below, are to read the instance from file, construct the optimization model, run the optimization and extract the optimal solution.</p>
<pre><code class="julia">using Cbc
using UnitCommitment
# Read instance
instance = UnitCommitment.read(&quot;/path/to/input.json&quot;)
# Construct optimization model
model = UnitCommitment.build_model(instance, Cbc.Optimizer)
# Solve model
UnitCommitment.optimize!(model)
# Extract solution and write it to a file
solution = UnitCommitment.get_solution(model)
open(&quot;/path/to/output.json&quot;, &quot;w&quot;) do file
JSON.print(file, solution, 2)
end
</code></pre>
<h3 id="22-solving-benchmark-instances">2.2 Solving benchmark instances</h3>
<p>As described in the <a href="">instances page</a>, UnitCommitment.jl contains a number of benchmark instances collected from the literature. To solve one of these instances individually, instead of constructing your own, the function <code>read_benchmark</code> can be used:</p>
<pre><code class="julia">using UnitCommitment
instance = UnitCommitment.read_benchmark(&quot;matpower/case3375wp/2017-01-01&quot;)
</code></pre>
<h2 id="3-advanced-usage">3. Advanced usage</h2>
<h3 id="31-modifying-the-formulation">3.1 Modifying the formulation</h3>
<p>For the time being, the recommended way of modifying the MILP formulation used by UC.jl is to create a local copy of our git repository and directly modify the source code of the package. In a future version, it will be possible to switch between multiple formulations, or to simply add/remove constraints after the model has been generated.</p>
<h3 id="32-generating-initial-conditions">3.2 Generating initial conditions</h3>
<p>When creating random unit commitment instances for benchmark purposes, it is often hard to compute, in advance, sensible initial conditions for all generators. Setting initial conditions naively (for example, making all generators initially off and producing no power) can easily cause the instance to become infeasible due to excessive ramping. Initial conditions can also make it hard to modify existing instances. For example, increasing the system load without carefully modifying the initial conditions may make the problem infeasible or unrealistically challenging to solve.</p>
<p>To help with this issue, UC.jl provides a utility function which can generate feasible initial conditions by solving a single-period optimization problem, as shown below:</p>
<pre><code class="julia">using Cbc
using UnitCommitment
# Read original instance
instance = UnitCommitment.read(&quot;instance.json&quot;)
# Generate initial conditions (in-place)
UnitCommitment.generate_initial_conditions!(instance, Cbc.Optimizer)
# Construct and solve optimization model
model = UnitCommitment.build_model(instance, Cbc.Optimizer)
UnitCommitment.optimize!(model)
</code></pre>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
<p>The function <code>generate_initial_conditions!</code> may return different initial conditions after each call, even if the same instance and the same optimizer is provided. The particular algorithm may also change in a future version of UC.jl. For these reasons, it is recommended that you generate initial conditions exactly once for each instance and store them for later use.</p>
</div>
<h3 id="33-verifying-solutions">3.3 Verifying solutions</h3>
<p>When developing new formulations, it is very easy to introduce subtle errors in the model that result in incorrect solutions. To help with this, UC.jl includes a utility function that verifies if a given solution is feasible, and, if not, prints all the validation errors it found. The implementation of this function is completely independent from the implementation of the optimization model, and therefore can be used to validate it. The function can also be used to verify solutions produced by other optimization packages, as long as they follow the <a href="../format/">UC.jl data format</a>.</p>
<pre><code class="julia">using JSON
using UnitCommitment
# Read instance
instance = UnitCommitment.read(&quot;instance.json&quot;)
# Read solution (potentially produced by other packages)
solution = JSON.parsefile(&quot;solution.json&quot;)
# Validate solution and print validation errors
UnitCommitment.validate(instance, solution)
</code></pre></div>
@@ -155,6 +232,8 @@
<script src="//cdn.jsdelivr.net/gh/highlightjs/cdn-release@9.18.0/build/highlight.min.js"></script>
<script src="//cdn.jsdelivr.net/gh/highlightjs/cdn-release@9.18.0/build/languages/julia.min.js"></script>
<script>hljs.initHighlightingOnLoad();</script>