Minor fixes to documentation

Package dependencies

.gitattributes

@@ -1 +1,6 @@
 * text=auto
+*.bz2 diff=bz2
+*.gz diff=gzip
+*.tar diff=tar
+*.tar.bz2 diff=tar-bz2
+*.zip diff=zip

.github/workflows/benchmark.yml

@@ -1,14 +1,9 @@
 name: Benchmark
-on:
-  push:
-    paths-ignore:
-      - '**.csv'
-      - '**.md'
-      - '.git*'
-      - 'test/**'
+on: push
 jobs:
   benchmark:
     runs-on: [self-hosted, benchmark]
+    if: "contains(github.event.head_commit.message, '[benchmark]')"
     timeout-minutes: 10080
     steps:
     - uses: actions/checkout@v1
@@ -23,11 +18,11 @@ jobs:
     - name: Upload logs
       uses: actions/upload-artifact@v2
       with:
-        name: logs
+        name: Logs
         path: benchmark/results/*
     - name: Upload tables & charts
       uses: actions/upload-artifact@v2
       with:
-        name: tables
+        name: Tables
         path: benchmark/tables/*
 

.github/workflows/tagbot.yml

@@ -0,0 +1,11 @@
+name: TagBot
+on:
+  schedule:
+    - cron: 0 * * * *
+jobs:
+  TagBot:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: JuliaRegistries/TagBot@v1
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/test.yml

@@ -1,9 +1,20 @@
 name: Tests
-on: push
+on: [push, pull_request]
 jobs:
   test:
-    runs-on: self-hosted
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        julia-version: ['1.3', '1.4', '1']
+        julia-arch: [x64, x86]
+        os: [ubuntu-latest, windows-latest, macOS-latest]
+        exclude:
+          - os: macOS-latest
+            julia-arch: x86
     steps:
-    - uses: actions/checkout@v1
-    - name: Run unit tests
-      run: julia --project=@. -e 'using Pkg; Pkg.test("UnitCommitment")'
+      - uses: actions/checkout@v2
+      - uses: julia-actions/setup-julia@latest
+        with:
+          version: ${{ matrix.julia-version }}
+      - uses: julia-actions/julia-buildpkg@latest
+      - uses: julia-actions/julia-runtest@latest

.gitignore

@@ -3,6 +3,7 @@
 *.lastrun
 *.so
 *.mps
+*.ipynb
 .ipy*
 benchmark/results
 benchmark/runs

CHANGELOG.md

@@ -1,5 +1,11 @@
 # UnitCommitment.jl
 
-### Version 0.1.0 (November 6, 2020)
+### Version 0.1.1 (Nov 16, 2020)
+
+* Fixes to MATLAB and PGLIB-UC instances
+* Add OR-LIB and Tejada19 instances
+* Improve documentation
+
+### Version 0.1.0 (Nov 6, 2020)
 
 * Initial public release

Project.toml

@@ -2,10 +2,9 @@ name = "UnitCommitment"
 uuid = "64606440-39ea-11e9-0f29-3303a1d3d877"
 authors = ["Santos Xavier, Alinson <axavier@anl.gov>"]
 repo = "https://github.com/ANL-CEEESA/UnitCommitment.jl"
-version = "0.1.0"
+version = "0.1.1"
 
 [deps]
-Cbc = "9961bab8-2fa3-5c5a-9d89-47fab24efd76"
 DataStructures = "864edb3b-99cc-5e75-8d2d-829cb0a9cfe8"
 GZip = "92fee26a-97fe-5a0c-ad85-20a5f3185b63"
 JSON = "682c06a0-de6a-54ab-a142-c8b1cf79cde6"
@@ -16,7 +15,6 @@ MathOptInterface = "b8f27783-ece8-5eb3-8dc8-9495eed66fee"
 PackageCompiler = "9b87118b-4619-50d2-8e1e-99f35a4d4d9d"
 Printf = "de0858da-6303-5e67-8744-51eddeeeb8d7"
 SparseArrays = "2f01184e-e22b-5df5-ae63-d93ebab69eaf"
-Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40"
 
 [compat]
 Cbc = "0.7"
@@ -27,3 +25,10 @@ JuMP = "0.21"
 MathOptInterface = "0.9"
 PackageCompiler = "1"
 julia = "1"
+
+[extras]
+Cbc = "9961bab8-2fa3-5c5a-9d89-47fab24efd76"
+Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40"
+
+[targets]
+test = ["Cbc", "Test"]

README.md

@@ -1,5 +1,8 @@
-<a href="https://github.com/iSoron/UnitCommitment.jl/actions?query=workflow%3ATest+branch%3Adev"><img src="https://github.com/iSoron/UnitCommitment.jl/workflows/Tests/badge.svg"></img></a>
-<a href="https://github.com/iSoron/UnitCommitment.jl/actions?query=workflow%3ABenchmark+branch%3Adev"><img src="https://github.com/iSoron/UnitCommitment.jl/workflows/Benchmark/badge.svg"></img></a>
+<a href="https://github.com/ANL-CEEESA/UnitCommitment.jl/actions?query=workflow%3ATest+branch%3Adev"><img src="https://github.com/iSoron/UnitCommitment.jl/workflows/Tests/badge.svg"></img></a>
+<a href="https://github.com/ANL-CEEESA/UnitCommitment.jl/actions?query=workflow%3ABenchmark+branch%3Adev"><img src="https://github.com/iSoron/UnitCommitment.jl/workflows/Benchmark/badge.svg"></img></a>
+<a href="https://zenodo.org/badge/latestdoi/263667075"><img src="https://zenodo.org/badge/263667075.svg" alt="DOI"></a>
+
+
 
 # UnitCommitment.jl
 
@@ -14,8 +17,9 @@
 
 ### Documentation
 
-* [Usage](https://axavier.org/projects/UnitCommitment.jl/usage/)
-* [Data Format](https://axavier.org/projects/UnitCommitment.jl/format/)
+* [Usage](https://anl-ceeesa.github.io/UnitCommitment.jl/0.1/usage/)
+* [Data Format](https://anl-ceeesa.github.io/UnitCommitment.jl/0.1/format/)
+* [Instances](https://anl-ceeesa.github.io/UnitCommitment.jl/0.1/instances/)
 
 ### Authors
 * **Alinson Santos Xavier** (Argonne National Laboratory)
@@ -27,6 +31,15 @@
 
 * Based upon work supported by **Laboratory Directed Research and Development** (LDRD) funding from Argonne National Laboratory, provided by the Director, Office of Science, of the U.S. Department of Energy under Contract No. DE-AC02-06CH11357.
 
+### Citing
+
+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).
+
+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/).
+
 ### License
 
-Released under the modified BSD license. See `LICENSE.md` for more details.
+Released under the modified BSD license. See `LICENSE.md` for more details.
+

benchmark/Makefile

@@ -10,56 +10,15 @@ SRC_FILES := $(wildcard ../src/*.jl)
 INSTANCES_PGLIB := \
         pglib-uc/ca/2014-09-01_reserves_0 \
         pglib-uc/ca/2014-09-01_reserves_1 \
-        pglib-uc/ca/2014-09-01_reserves_3 \
-        pglib-uc/ca/2014-09-01_reserves_5 \
-        pglib-uc/ca/2014-12-01_reserves_0 \
-        pglib-uc/ca/2014-12-01_reserves_1 \
-        pglib-uc/ca/2014-12-01_reserves_3 \
-        pglib-uc/ca/2014-12-01_reserves_5 \
         pglib-uc/ca/2015-03-01_reserves_0 \
-        pglib-uc/ca/2015-03-01_reserves_1 \
-        pglib-uc/ca/2015-03-01_reserves_3 \
-        pglib-uc/ca/2015-03-01_reserves_5 \
         pglib-uc/ca/2015-06-01_reserves_0 \
-        pglib-uc/ca/2015-06-01_reserves_1 \
-        pglib-uc/ca/2015-06-01_reserves_3 \
-        pglib-uc/ca/2015-06-01_reserves_5 \
-        pglib-uc/ca/Scenario400_reserves_0 \
         pglib-uc/ca/Scenario400_reserves_1 \
-        pglib-uc/ca/Scenario400_reserves_3 \
-        pglib-uc/ca/Scenario400_reserves_5 \
-        pglib-uc/ferc/2015-01-01_hw \
         pglib-uc/ferc/2015-01-01_lw \
-        pglib-uc/ferc/2015-02-01_hw \
-        pglib-uc/ferc/2015-02-01_lw \
-        pglib-uc/ferc/2015-03-01_hw \
-        pglib-uc/ferc/2015-03-01_lw \
-        pglib-uc/ferc/2015-04-01_hw \
-        pglib-uc/ferc/2015-04-01_lw \
-        pglib-uc/ferc/2015-05-01_hw \
         pglib-uc/ferc/2015-05-01_lw \
-        pglib-uc/ferc/2015-06-01_hw \
-        pglib-uc/ferc/2015-06-01_lw \
         pglib-uc/ferc/2015-07-01_hw \
-        pglib-uc/ferc/2015-07-01_lw \
-        pglib-uc/ferc/2015-08-01_hw \
-        pglib-uc/ferc/2015-08-01_lw \
-        pglib-uc/ferc/2015-09-01_hw \
-        pglib-uc/ferc/2015-09-01_lw \
-        pglib-uc/ferc/2015-10-01_hw \
         pglib-uc/ferc/2015-10-01_lw \
-        pglib-uc/ferc/2015-11-02_hw \
-        pglib-uc/ferc/2015-11-02_lw \
-        pglib-uc/ferc/2015-12-01_hw \
         pglib-uc/ferc/2015-12-01_lw \
-        pglib-uc/rts_gmlc/2020-01-27 \
-        pglib-uc/rts_gmlc/2020-02-09 \
-        pglib-uc/rts_gmlc/2020-03-05 \
         pglib-uc/rts_gmlc/2020-04-03 \
-        pglib-uc/rts_gmlc/2020-05-05 \
-        pglib-uc/rts_gmlc/2020-06-09 \
-        pglib-uc/rts_gmlc/2020-07-06 \
-        pglib-uc/rts_gmlc/2020-08-12 \
         pglib-uc/rts_gmlc/2020-09-20 \
         pglib-uc/rts_gmlc/2020-10-27 \
         pglib-uc/rts_gmlc/2020-11-25 \
@@ -71,42 +30,64 @@ INSTANCES_MATPOWER := \
 	matpower/case300/2017-02-01 \
 	matpower/case300/2017-08-01 \
 	matpower/case1354pegase/2017-02-01 \
-	matpower/case1354pegase/2017-08-01 \
 	matpower/case1888rte/2017-02-01 \
-	matpower/case1888rte/2017-08-01 \
-	matpower/case1951rte/2017-02-01 \
 	matpower/case1951rte/2017-08-01 \
 	matpower/case2848rte/2017-02-01 \
-	matpower/case2848rte/2017-08-01 \
-	matpower/case2868rte/2017-02-01 \
 	matpower/case2868rte/2017-08-01 \
-	matpower/case3375wp/2017-02-01 \
 	matpower/case3375wp/2017-08-01 \
-	matpower/case6468rte/2017-02-01 \
 	matpower/case6468rte/2017-08-01 \
-	matpower/case6515rte/2017-02-01 \
 	matpower/case6515rte/2017-08-01
 
-SAMPLES := 1 2 3
+INSTANCES_ORLIB := \
+	or-lib/20_0_1_w \
+	or-lib/20_0_5_w \
+	or-lib/50_0_2_w \
+	or-lib/75_0_2_w \
+	or-lib/100_0_1_w \
+	or-lib/100_0_4_w \
+	or-lib/100_0_5_w \
+	or-lib/200_0_3_w \
+	or-lib/200_0_7_w \
+	or-lib/200_0_9_w
+
+INSTANCES_TEJADA19 := \
+	tejada19/UC_24h_290g \
+	tejada19/UC_24h_623g \
+	tejada19/UC_24h_959g \
+	tejada19/UC_24h_1577g \
+	tejada19/UC_24h_1888g \
+	tejada19/UC_168h_72g \
+	tejada19/UC_168h_86g \
+	tejada19/UC_168h_130g \
+	tejada19/UC_168h_131g \
+	tejada19/UC_168h_199g
+
+SAMPLES := 1 2 3 4 5
 SOLUTIONS_MATPOWER := $(foreach s,$(SAMPLES),$(addprefix results/,$(addsuffix .$(s).sol.json,$(INSTANCES_MATPOWER))))
 SOLUTIONS_PGLIB := $(foreach s,$(SAMPLES),$(addprefix results/,$(addsuffix .$(s).sol.json,$(INSTANCES_PGLIB))))
+SOLUTIONS_ORLIB := $(foreach s,$(SAMPLES),$(addprefix results/,$(addsuffix .$(s).sol.json,$(INSTANCES_ORLIB))))
+SOLUTIONS_TEJADA19 := $(foreach s,$(SAMPLES),$(addprefix results/,$(addsuffix .$(s).sol.json,$(INSTANCES_TEJADA19))))
 
-.PHONY: tables save small large clean-mps matpower pglib
+.PHONY: tables save small large clean-mps matpower pglib orlib
 
-all: matpower pglib
+all: matpower pglib orlib tejada19
 
 matpower: $(SOLUTIONS_MATPOWER)
 
 pglib: $(SOLUTIONS_PGLIB)
 
+orlib: $(SOLUTIONS_ORLIB)
+
+tejada19: $(SOLUTIONS_TEJADA19)
+
 clean:
 	@rm -rf tables/benchmark* tables/compare* results
     
 clean-mps:
-	@rm -fv results/*/*/*.mps.gz
+	@rm -fv results/*/*.mps.gz results/*/*/*.mps.gz
 
 clean-sol:
-	@rm -rf results/*/*/*.sol.*
+	@rm -rf results/*/*.sol.* results/*/*/*.sol.*
         
 save:
 	mkdir -p "runs/$(TIMESTAMP)"

benchmark/scripts/compare.py

@@ -8,7 +8,7 @@ import seaborn as sns
 import matplotlib.pyplot as plt
 import sys
 
-easy_cutoff = 120
+#easy_cutoff = 120
 
 b1 = pd.read_csv(sys.argv[1], index_col=0)
 b2 = pd.read_csv(sys.argv[2], index_col=0)
@@ -24,10 +24,10 @@ merged["Time diff (s)"] = merged["B Time (s)"] - merged["A Time (s)"]
 merged["Value diff (%)"] = np.round((merged["B Value"] - merged["A Value"]) / merged["A Value"] * 100.0, 5)
 merged.loc[merged.loc[:, "B Time (s)"] <= 0, "Speedup"] = float("nan")
 merged.loc[merged.loc[:, "B Time (s)"] <= 0, "Time diff (s)"] = float("nan")
-merged = merged[(merged["A Time (s)"] >= easy_cutoff) | (merged["B Time (s)"] >= easy_cutoff)]
+#merged = merged[(merged["A Time (s)"] >= easy_cutoff) | (merged["B Time (s)"] >= easy_cutoff)]
 merged.reset_index(inplace=True)
 merged["Name"] = merged["Group"] + "/" + merged["Instance"]
-merged = merged.sort_values(by="Speedup", ascending=False)
+#merged = merged.sort_values(by="Speedup", ascending=False)
 
 
 k = len(merged.groupby("Name"))

benchmark/scripts/table.py

@@ -9,7 +9,8 @@ from tabulate import tabulate
 
 
 def process_all_log_files():
-    pathlist = Path(".").glob('results/*/*/*.log')
+    pathlist = list(Path(".").glob('results/*/*/*.log'))
+    pathlist += list(Path(".").glob('results/*/*.log'))
     rows = []
     for path in pathlist:
         if ".ipy" in str(path):

instances/README.md

@@ -1,29 +1,53 @@
-UnitCommitment.jl Instances
-===========================
+Instances
+=========
+
+UnitCommitment.jl provides a large collection of benchmark instances collected
+from the literature and converted to a common data format. If you use these instances in your research, we request that you cite UnitCommitment.jl, as well as the original sources, as listed below. [See documentation for more details](https://anl-ceeesa.github.io/UnitCommitment.jl/).
 
 References
 ----------
 
-### PGLIB-UC
+### UnitCommitment.jl
 
-* Coffrin, Carleton and Knueven, Bernard. "Power Grid Lib - Unit Commitment". https://github.com/power-grid-lib/pglib-uc
+* [UCJL] **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)
 
-* Knueven, Bernard, James Ostrowski, and Jean-Paul Watson. "On mixed integer programming formulations for the unit commitment problem." Pre-print available at http://www.optimization-online.org/DB_HTML/2018/11/6930.pdf (2018).
-
-* Krall, Eric, Michael Higgins, and Richard P. O’Neill. "RTO unit commitment test system." Federal Energy Regulatory Commission. Available: http://ferc.gov/legal/staff-reports/rto-COMMITMENT-TEST.pdf (2012).
 
 ### MATPOWER
 
-* https://github.com/MATPOWER/matpower
+* [MTPWR] **D. Zimmerman, C. E. Murillo-Sandnchez and R. J. Thomas.** "Matpower:  Steady-state  operations,  planning,  and  analysis  tools  forpower systems research and education", IEEE Transactions on PowerSystems, vol. 26, no. 1, pp. 12 –19, Feb. 2011. [DOI: 10.1109/TPWRS.2010.2051168](https://doi.org/10.1109/TPWRS.2010.2051168)
 
-* R. D. Zimmerman, C. E. Murillo-Sanchez, and R. J. Thomas, "MATPOWER: Steady-State Operations, Planning and Analysis Tools for Power Systems Research and Education," Power Systems, IEEE Transactions on, vol. 26, no. 1, pp. 12–19, Feb. 2011.
+* [PSTCA] **University of Washington, Dept. of Electrical Engineering.** "Power Systems Test Case Archive". Available at: <http://www.ee.washington.edu/research/pstca/> (Accessed: Nov 14, 2020)
 
-* C. Josz, S. Fliscounakis, J. Maeght, and P. Panciatici, "AC Power Flow Data in MATPOWER and QCQP Format: iTesla, RTE Snapshots, and PEGASE" https://arxiv.org/abs/1603.01533
+* [JoFlMa16] **C. Josz, S. Fliscounakis, J. Maeght, and P. Panciatici.** "AC Power Flow
+Data in MATPOWER and QCQP Format: iTesla, RTE Snapshots, and PEGASE". [ArXiv (2016)](https://arxiv.org/abs/1603.01533).
 
-* S. Fliscounakis, P. Panciatici, F. Capitanescu, and L. Wehenkel, "Contingency ranking with respect to overloads in very large power systems taking into account uncertainty, preventive and corrective actions", Power Systems, IEEE Trans. on, (28)4:4909-4917, 2013. https://doi.org/10.1109/TPWRS.2013.2251015
+* [FlPaCa13] **S. Fliscounakis, P. Panciatici, F. Capitanescu, and L. Wehenkel.**
+"Contingency ranking with respect to overloads in very large power
+systems taking into account uncertainty, preventive and corrective
+actions", Power Systems, IEEE Trans. on, (28)4:4909-4917, 2013.
+[DOI: 10.1109/TPWRS.2013.2251015](https://doi.org/10.1109/TPWRS.2013.2251015)
+
+
+### PGLIB-UC
+
+* [PGLIB] **Carleton Coffrin and Bernard Knueven.** "Power Grid Lib - Unit Commitment". Available at: <https://github.com/power-grid-lib/pglib-uc> (Accessed: Nov 14, 2020)
+
+* [KrHiOn12] **Eric Krall, Michael Higgins and Richard P. O’Neill.** "RTO unit commitment test system." Federal Energy Regulatory Commission. Available at: <https://www.ferc.gov/industries-data/electric/power-sales-and-markets/increasing-efficiency-through-improved-software-1> (Accessed: Nov 14, 2020)
+
+* [KnOsWa20] **Bernard Knueven, James Ostrowski and Jean-Paul Watson.** "On Mixed-Integer Programming Formulations for the Unit Commitment Problem". INFORMS Journal on Computing (2020). [DOI: 10.1287/ijoc.2019.0944](https://doi.org/10.1287/ijoc.2019.0944)
 
 ### RTS-GMLC
 
 * https://github.com/GridMod/RTS-GMLC
 
-* Barrows, Clayton, Aaron Bloom, Ali Ehlen, Jussi Ikaheimo, Jennie Jorgenson, Dheepak Krishnamurthy, Jessica Lau et al. "The IEEE Reliability Test System: A Proposed 2019 Update." IEEE Transactions on Power Systems (2019).
+* [BaBlEh19] **Clayton Barrows, Aaron Bloom, Ali Ehlen, Jussi Ikaheimo, Jennie Jorgenson, Dheepak Krishnamurthy, Jessica Lau et al.** "The IEEE Reliability Test System: A Proposed 2019 Update." IEEE Transactions on Power Systems (2019). [DOI: 10.1109/TPWRS.2019.2925557](https://doi.org/10.1109/TPWRS.2019.2925557)
+
+### OR-LIB
+
+* [ORLIB] **J.E.Beasley.** "OR-Library: distributing test problems by electronic mail", Journal of the Operational Research Society 41(11) (1990). [DOI: 10.2307/2582903](https://doi.org/10.2307/2582903)
+
+* [FrGe06] **A. Frangioni, C. Gentile.** "Solving nonlinear single-unit commitment problems with ramping constraints" Operations Research 54(4), p. 767 - 775, 2006. [DOI: 10.1287/opre.1060.0309](https://doi.org/10.1287/opre.1060.0309)
+
+### Tejada19
+
+* [TeLuSa19] **D. A. Tejada-Arango, S. Lumbreras, P. Sanchez-Martin and A. Ramos.** "Which Unit-Commitment Formulation is Best? A Systematic Comparison," in IEEE Transactions on Power Systems. [DOI: 10.1109/TPWRS.2019.2962024](https://ieeexplore.ieee.org/document/8941313/).