Flatten dir structure, update docstrings

This commit is contained in:
2023-03-15 12:08:35 -05:00
parent 34ca6952fb
commit d2e11eee42
11 changed files with 135 additions and 203 deletions

View File

@@ -1,4 +1,5 @@
[deps]
Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
JuMP = "4076af6c-e467-56ae-b986-b466b2749572"
Revise = "295af30f-e4ad-537b-8983-00126c2a3abe"
UnitCommitment = "64606440-39ea-11e9-0f29-3303a1d3d877"

View File

@@ -1,4 +1,4 @@
using Documenter, UnitCommitment
using Documenter, UnitCommitment, JuMP
makedocs(
sitename="UnitCommitment.jl",

View File

@@ -12,6 +12,20 @@ UnitCommitment.validate
UnitCommitment.write
```
## Locational Marginal Prices
### Conventional LMPs
```@docs
UnitCommitment.compute_lmp(::JuMP.Model,::UnitCommitment.ConventionalLMP)
```
### Approximated Extended LMPs
```@docs
UnitCommitment.AELMP
UnitCommitment.compute_lmp(::JuMP.Model,::UnitCommitment.AELMP)
```
## Modify instance
```@docs