Update 0.2 docs

0.2/_sources/index.md.txt

@@ -23,7 +23,7 @@
 
 ### Citing
 
-If you use UnitCommitment.jl in your research (that is, if you use either the provided instances files, the mathematical models, or the algorithms), we kindly request that you cite the package as follows:
+If you use UnitCommitment.jl in your research (instances, models or algorithms), we kindly request that you cite the package as follows:
 
 * **Alinson S. Xavier, Feng Qiu**, "UnitCommitment.jl: A Julia/JuMP Optimization Package for Security-Constrained Unit Commitment". Zenodo (2020). [DOI: 10.5281/zenodo.4269874](https://doi.org/10.5281/zenodo.4269874).
 

0.2/_sources/model.md.txt

@@ -11,7 +11,6 @@ JuMP Model
 
 In this page, we describe the JuMP optimization model produced by the function `UnitCommitment.build_model`. A detailed understanding of this model is not necessary if you are just interested in using the package to solve some standard unit commitment cases, but it may be useful, for example, if you need to solve a slightly different problem, with additional variables and constraints. The notation in this page generally follows [KnOsWa20].
 
-
 Decision variables
 ------------------
 
@@ -161,7 +160,7 @@ using UnitCommitment
 # Load benchmark instance
 instance = UnitCommitment.read_benchmark("matpower/case118/2017-02-01")
 
-# Construct JuMP
+# Construct JuMP model
 model = UnitCommitment.build_model(
     instance=instance,
     optimizer=Cbc.Optimizer,
@@ -194,6 +193,7 @@ UnitCommitment.optimize!(model)
 ### Adding components to a bus
 
 
+One of the most common modifications to a unit commitment model is adding a new customized system component to a bus. The script below shows how to add 
 
 
 References

0.2/index.html

@@ -246,7 +246,7 @@
 </div>
 <div class="section" id="citing">
 <h2>Citing<a class="headerlink" href="#citing" title="Permalink to this headline">¶</a></h2>
-<p>If you use UnitCommitment.jl in your research (that is, if you use either the provided instances files, the mathematical models, or the algorithms), we kindly request that you cite the package as follows:</p>
+<p>If you use UnitCommitment.jl in your research (instances, models or algorithms), we kindly request that you cite the package as follows:</p>
 <ul class="simple">
 <li><p><strong>Alinson S. Xavier, Feng Qiu</strong>, “UnitCommitment.jl: A Julia/JuMP Optimization Package for Security-Constrained Unit Commitment”. Zenodo (2020). <a class="reference external" href="https://doi.org/10.5281/zenodo.4269874">DOI: 10.5281/zenodo.4269874</a>.</p></li>
 </ul>

0.2/model/index.html

@@ -496,7 +496,7 @@
 <span class="c"># Load benchmark instance</span>
 <span class="n">instance</span> <span class="o">=</span> <span class="n">UnitCommitment</span><span class="o">.</span><span class="n">read_benchmark</span><span class="p">(</span><span class="s">&quot;matpower/case118/2017-02-01&quot;</span><span class="p">)</span>
 
-<span class="c"># Construct JuMP</span>
+<span class="c"># Construct JuMP model</span>
 <span class="n">model</span> <span class="o">=</span> <span class="n">UnitCommitment</span><span class="o">.</span><span class="n">build_model</span><span class="p">(</span>
     <span class="n">instance</span><span class="o">=</span><span class="n">instance</span><span class="p">,</span>
     <span class="n">optimizer</span><span class="o">=</span><span class="n">Cbc</span><span class="o">.</span><span class="n">Optimizer</span><span class="p">,</span>
@@ -529,6 +529,7 @@
 </div>
 <div class="section" id="adding-components-to-a-bus">
 <h3>Adding components to a bus<a class="headerlink" href="#adding-components-to-a-bus" title="Permalink to this headline">¶</a></h3>
+<p>One of the most common modifications to a unit commitment model is adding a new customized system component to a bus. The script below shows how to add</p>
 </div>
 </div>
 <div class="section" id="references">