mirror of
https://github.com/ANL-CEEESA/UnitCommitment.jl.git
synced 2025-12-06 08:18:51 -06:00
Switch to Documenter.jl
This commit is contained in:
48
docs/src/api.md
Normal file
48
docs/src/api.md
Normal file
@@ -0,0 +1,48 @@
|
||||
# API Reference
|
||||
|
||||
## Read data, build model & optimize
|
||||
|
||||
```@docs
|
||||
UnitCommitment.read
|
||||
UnitCommitment.read_benchmark
|
||||
UnitCommitment.build_model
|
||||
UnitCommitment.optimize!
|
||||
UnitCommitment.solution
|
||||
UnitCommitment.validate
|
||||
UnitCommitment.write
|
||||
```
|
||||
|
||||
## Modify instance
|
||||
|
||||
```@docs
|
||||
UnitCommitment.slice
|
||||
UnitCommitment.randomize!
|
||||
generate_initial_conditions!
|
||||
```
|
||||
|
||||
## Formulations
|
||||
|
||||
```@docs
|
||||
UnitCommitment.ArrCon2000
|
||||
UnitCommitment.CarArr2006
|
||||
UnitCommitment.DamKucRajAta2016
|
||||
UnitCommitment.Gar1962
|
||||
UnitCommitment.KnuOstWat2018
|
||||
UnitCommitment.MorLatRam2013
|
||||
UnitCommitment.PanGua2016
|
||||
UnitCommitment.WanHob2016
|
||||
```
|
||||
|
||||
## Solution Methods
|
||||
|
||||
```@docs
|
||||
UnitCommitment.XavQiuWanThi2019
|
||||
UnitCommitment.XavQiuWanThi2019.Method
|
||||
```
|
||||
|
||||
## Randomization Methods
|
||||
|
||||
```@docs
|
||||
UnitCommitment.XavQiuAhm2021
|
||||
UnitCommitment.XavQiuAhm2021.Randomization
|
||||
```
|
||||
Reference in New Issue
Block a user