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

Minor fixes to documentation

Browse Source
This commit is contained in:
Alinson S. Xavier
2020-11-16 06:39:39 -06:00
parent dbd4d784dd
commit 23de0345b3
2 changed files with 3 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
README.md
View File

@@ -35,7 +35,7 @@
If you use UnitCommitment.jl in your research, we request that you cite the package as follows: If you use UnitCommitment.jl in your research, we 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). * **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).
If you make use of the provided instances files, we request that you additionally cite the original sources, as described in the [instances page](https://anl-ceeesa.github.io/UnitCommitment.jl/0.1/instances/). If you make use of the provided instances files, we request that you additionally cite the original sources, as described in the [instances page](https://anl-ceeesa.github.io/UnitCommitment.jl/0.1/instances/).

4
src/docs/usage.md
View File

@@ -5,7 +5,7 @@
UnitCommitment.jl was tested and developed with [Julia 1.5](https://julialang.org/). To install Julia, please follow the [installation guide on the official Julia website](https://julialang.org/downloads/platform.html). To install UnitCommitment.jl, run the Julia interpreter, type `]` to open the package manager, then type: UnitCommitment.jl was tested and developed with [Julia 1.5](https://julialang.org/). To install Julia, please follow the [installation guide on the official Julia website](https://julialang.org/downloads/platform.html). To install UnitCommitment.jl, run the Julia interpreter, type `]` to open the package manager, then type:
```text ```text
pkg> add https://github.com/ANL-CEEESA/UnitCommitment.jl.git pkg> add UnitCommitment
``` ```
To test that the package has been correctly installed, run: To test that the package has been correctly installed, run:
@@ -50,7 +50,7 @@ As described in the [Instances page](instances.md), UnitCommitment.jl contains a
```julia ```julia
using UnitCommitment using UnitCommitment
instance = UnitCommitment.read_benchmark("matpower/case3375wp/2017-01-01") instance = UnitCommitment.read_benchmark("matpower/case3375wp/2017-02-01")
``` ```
## 3. Advanced usage ## 3. Advanced usage