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

Improve docs

Browse Source
This commit is contained in:
Alinson S. Xavier
2022-07-17 15:50:42 -06:00
parent 18daaf5358
commit 5fef01cd99
12 changed files with 160 additions and 50 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
src/instance/read.jl
View File

@@ -13,15 +13,13 @@ const INSTANCES_URL = "https://axavier.org/UnitCommitment.jl/0.3/instances"
"""
read_benchmark(name::AbstractString)::UnitCommitmentInstance
Read one of the benchmark unit commitment instances included in the package.
See "Instances" section of the documentation for the entire list of benchmark
instances available.
Read one of the benchmark instances included in the package. See
[Instances](instances.md) for the entire list of benchmark instances available.
Example
-------
import UnitCommitment
instance = UnitCommitment.read_benchmark("matpower/case3375wp/2017-02-01")
# Example
```julia
instance = UnitCommitment.read_benchmark("matpower/case3375wp/2017-02-01")
```
"""
function read_benchmark(
name::AbstractString;
@@ -48,13 +46,13 @@ end
"""
read(path::AbstractString)::UnitCommitmentInstance
Read a unit commitment instance from a file. The file may be gzipped.
Read instance from a file. The file may be gzipped.
Example
-------
# Example
import UnitCommitment
instance = UnitCommitment.read("/path/to/input.json.gz")
```julia
instance = UnitCommitment.read("/path/to/input.json.gz")
```
"""
function read(path::AbstractString)::UnitCommitmentInstance
if endswith(path, ".gz")