Add UnitCommitment.jl (#31)

* Add UnitCommitment.jl

* Update ci_frameworks.yml

* Cleanup

* organize main

* improve readme

* cleanup ucjl main

* Update ci_frameworks.yml

* Add unit commitment cases

.github/workflows/ci_frameworks.yml

@@ -34,6 +34,10 @@ jobs:
           #   case: '1_EU_investment_simple'
           #   file: 'main.jl'
           #   os: ubuntu-latest
+          - framework: 'UnitCommitment'
+            case: 'matpower/case14/2017-01-01' # small non-default case
+            file: 'main.jl'
+            os: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
       - uses: julia-actions/setup-julia@v2

Makefile

@@ -12,6 +12,7 @@ help:
 	@echo "  sienna       write all Sienna instances"
 	@echo "  spineopt     write all SpineOpt instances"
 	@echo "  tulipaenergymodel  write all TulipaEnergyModel instances"
+	@echo "  unitcommitment  write all UnitCommitment instances"
 	@echo "  [HIGHS=X.Y.Z] benchmark  run a new set of benchmarks, optionally with a version of HiGHS"
 	@echo "  analyze      print analysis of output"
 	@echo "  all          re-run all commands"
@@ -31,6 +32,9 @@ spineopt:
 tulipaenergymodel:
 	julia --project=TulipaEnergyModel TulipaEnergyModel/main.jl --all --run --write
 
+unitcommitment:
+	julia --project=UnitCommitment UnitCommitment/main.jl --all --run --write
+
 benchmark:
 	@if [ ${HIGHS} ]; then\
 		echo ${HIGHS};\
@@ -42,6 +46,6 @@ benchmark:
 analyze:
 	julia --project=benchmark benchmark/main.jl --analyze
 
-all: genx powermodels sienna spineopt tulipaenergymodel
+all: genx powermodels sienna spineopt tulipaenergymodel unitcommitment
 
-.PHONY: default help genx powermodels sienna spineopt tulipaenergymodel benchmark analyze
+.PHONY: default help genx powermodels sienna spineopt tulipaenergymodel unitcommitment benchmark analyze

README.md

@@ -131,3 +131,20 @@ julia --project=TulipaEnergyModel TulipaEnergyModel/main.jl --case=1_EU_investme
 ```
 
 See the `TulipaEnergyModel/main.jl` driver script for more details.
+
+### UnitCommitment
+
+For now, we can rebuild all of the UnitCommitment examples with (from the
+root of this directory):
+
+```sh
+make unitcommitment
+```
+
+To run a particular case, do:
+
+```sh
+julia --project=UnitCommitment UnitCommitment/main.jl --case=matpower/case1888rte/2017-01-01 --run [--write]
+```
+
+See the `UnitCommitment/main.jl` driver script for more details.