Update 0.3 docs

docs
Alinson S. Xavier 3 years ago
parent f666bfb110
commit 41694a905c

@ -24,7 +24,9 @@ Instances are specified by JSON files containing the following main sections:
* Reserves * Reserves
* Contingencies * Contingencies
Each section is described in detail below. Each section is described in detail below. See [case118/2017-01-01.json.gz][example] for a complete example.
[example]: https://axavier.org/UnitCommitment.jl/0.3/instances/matpower/case118/2017-01-01.json.gz
### Parameters ### Parameters
@ -303,3 +305,4 @@ Current limitations
* Only N-1 transmission contingencies are supported. Generator contingencies are not currently supported. * Only N-1 transmission contingencies are supported. Generator contingencies are not currently supported.
* Time-varying minimum production amounts are not currently compatible with ramp/startup/shutdown limits. * Time-varying minimum production amounts are not currently compatible with ramp/startup/shutdown limits.
* Flexible ramping products can only be acquired under the `WanHob2016` formulation, which does not support spinning reserves. * Flexible ramping products can only be acquired under the `WanHob2016` formulation, which does not support spinning reserves.

@ -9,7 +9,7 @@ suffix: .
Instances Instances
========= =========
UnitCommitment.jl provides a large collection of benchmark instances collected from the literature and converted to a [common data format](format.md). In some cases, as indicated below, the original instances have been extended, with realistic parameters, using data-driven methods. If you use these instances in your research, we request that you cite UnitCommitment.jl, as well as the original sources, as listed below. Benchmark instances can be loaded with `UnitCommitment.read_benchmark(name)`, as explained in the [usage section](usage.md). UnitCommitment.jl provides a large collection of benchmark instances collected from the literature and converted to a [common data format](format.md). In some cases, as indicated below, the original instances have been extended, with realistic parameters, using data-driven methods. If you use these instances in your research, we request that you cite UnitCommitment.jl, as well as the original sources, as listed below. Benchmark instances can be loaded with `UnitCommitment.read_benchmark(name)`, as explained in the [usage section](usage.md). Instance files can also be [directly downloaded from our website](https://axavier.org/UnitCommitment.jl/0.3/instances/).
```{warning} ```{warning}
The instances included in UC.jl are still under development and may change in the future. If you use these instances in your research, for reproducibility, you should specify what version of UC.jl they came from. The instances included in UC.jl are still under development and may change in the future. If you use these instances in your research, for reproducibility, you should specify what version of UC.jl they came from.

@ -321,7 +321,7 @@
<li><p>Reserves</p></li> <li><p>Reserves</p></li>
<li><p>Contingencies</p></li> <li><p>Contingencies</p></li>
</ul> </ul>
<p>Each section is described in detail below.</p> <p>Each section is described in detail below. See <a class="reference external" href="https://axavier.org/UnitCommitment.jl/0.3/instances/matpower/case118/2017-01-01.json.gz">case118/2017-01-01.json.gz</a> for a complete example.</p>
<div class="section" id="parameters"> <div class="section" id="parameters">
<h3>Parameters<a class="headerlink" href="#parameters" title="Permalink to this headline"></a></h3> <h3>Parameters<a class="headerlink" href="#parameters" title="Permalink to this headline"></a></h3>
<p>This section describes system-wide parameters, such as power balance penalty, and optimization parameters, such as the length of the planning horizon and the time.</p> <p>This section describes system-wide parameters, such as power balance penalty, and optimization parameters, such as the length of the planning horizon and the time.</p>

@ -256,7 +256,7 @@
<div class="section" id="instances"> <div class="section" id="instances">
<h1><span class="sectnum">3.</span> Instances<a class="headerlink" href="#instances" title="Permalink to this headline"></a></h1> <h1><span class="sectnum">3.</span> Instances<a class="headerlink" href="#instances" title="Permalink to this headline"></a></h1>
<p>UnitCommitment.jl provides a large collection of benchmark instances collected from the literature and converted to a <a class="reference internal" href="../format/"><span class="doc std std-doc">common data format</span></a>. In some cases, as indicated below, the original instances have been extended, with realistic parameters, using data-driven methods. If you use these instances in your research, we request that you cite UnitCommitment.jl, as well as the original sources, as listed below. Benchmark instances can be loaded with <code class="docutils literal notranslate"><span class="pre">UnitCommitment.read_benchmark(name)</span></code>, as explained in the <a class="reference internal" href="../usage/"><span class="doc std std-doc">usage section</span></a>.</p> <p>UnitCommitment.jl provides a large collection of benchmark instances collected from the literature and converted to a <a class="reference internal" href="../format/"><span class="doc std std-doc">common data format</span></a>. In some cases, as indicated below, the original instances have been extended, with realistic parameters, using data-driven methods. If you use these instances in your research, we request that you cite UnitCommitment.jl, as well as the original sources, as listed below. Benchmark instances can be loaded with <code class="docutils literal notranslate"><span class="pre">UnitCommitment.read_benchmark(name)</span></code>, as explained in the <a class="reference internal" href="../usage/"><span class="doc std std-doc">usage section</span></a>. Instance files can also be <a class="reference external" href="https://axavier.org/UnitCommitment.jl/0.3/instances/">directly downloaded from our website</a>.</p>
<div class="admonition warning"> <div class="admonition warning">
<p class="admonition-title">Warning</p> <p class="admonition-title">Warning</p>
<p>The instances included in UC.jl are still under development and may change in the future. If you use these instances in your research, for reproducibility, you should specify what version of UC.jl they came from.</p> <p>The instances included in UC.jl are still under development and may change in the future. If you use these instances in your research, for reproducibility, you should specify what version of UC.jl they came from.</p>

File diff suppressed because one or more lines are too long
Loading…
Cancel
Save