Start Github Actions CI

.github/workflows/ci.yml

@@ -0,0 +1,88 @@
+name: Tests
+
+on:
+  pull_request:
+  workflow_dispatch:
+
+jobs:
+  tests:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Check out repository
+        uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.11.5"
+
+      - name: Install system dependencies
+        run: |
+          sudo apt-get update
+          sudo apt-get install -y liblapack3 libblas3 gfortran
+
+      - name: Install latex
+        run: |
+          sudo apt-get install -y \
+          texlive-latex-base \
+          texlive-latex-recommended \
+          texlive-latex-extra \
+          texlive-fonts-recommended \
+          dvipng \
+          cm-super
+
+      - name: Install test dependencies
+        run: |
+          python -m pip install --upgrade pip
+          python -m pip install pybind11 setuptools pyomo idaes-pse
+          pyomo download-extensions
+          pyomo build-extensions
+          idaes get-extensions --to $GITHUB_WORKSPACE/.idaes
+          pushd $GITHUB_WORKSPACE/.idaes
+          tar -xf idaes-local-ubuntu*-x86_64.tar.gz
+          popd
+          tree $GITHUB_WORKSPACE/.idaes
+          export PKG_CONFIG_PATH="$GITHUB_WORKSPACE/.idaes/lib/pkgconfig:$PKG_CONFIG_PATH"
+          python -m pip install ".[test]"
+
+      - name: Run tests
+        run: |
+          export PATH="$PATH:$GITHUB_WORKSPACE/.idaes"
+          ipopt --version
+          python -m pytest \
+            var_elim/algorithms/tests \
+            var_elim/heuristics/tests \
+            var_elim/mip_formulations/tests
+
+      - name: Run structural analysis
+        run: |
+          export PATH="$PATH:$GITHUB_WORKSPACE/.idaes"
+          python reproduce.py structure --smoke --run-dir=.
+          test -s results/structure-distill.csv
+          test -s results/structure-distill.txt
+          test -s results/structure-distill-matching.txt
+          test -s images/fraction-elim.pdf
+          test -s images/nnz-per-con.pdf
+
+      - name: Run solvetime analysis
+        run: |
+          export PATH="$PATH:$GITHUB_WORKSPACE/.idaes"
+          export LD_LIBRARY_PATH="$LD_LIBRARY_PATH:$GITHUB_WORKSPACE/.idaes/lib"
+          export PKG_CONFIG_PATH="$GITHUB_WORKSPACE/.idaes/lib/pkgconfig:$PKG_CONFIG_PATH"
+          pkg-config --libs --cflags ipopt
+          python reproduce.py solvetime --smoke --run-dir=.
+          test -s results/solvetime-distill-matching.csv
+          test -s results/solvetime-distill-matching.txt
+          test -s images/fraction-solvetime.pdf
+
+      - name: Run convergence analysis
+        run: |
+          export PATH="$PATH:$GITHUB_WORKSPACE/.idaes"
+          export LD_LIBRARY_PATH="$LD_LIBRARY_PATH:$GITHUB_WORKSPACE/.idaes/lib"
+          export PKG_CONFIG_PATH="$GITHUB_WORKSPACE/.idaes/lib/pkgconfig:$PKG_CONFIG_PATH"
+          pkg-config --libs --cflags ipopt
+          python reproduce.py convergence --smoke --run-dir=.
+          test -s results/sweep/distill-matching-sweep.csv
+          test -s results/sweep/distill-matching-sweep-summary.csv
+          test -s images/distill-matching-sweep-convergence.pdf

COPYRIGHT.txt

@@ -0,0 +1,19 @@
+___________________________________________________________________________
+
+Variable Elimination: Research code for variable elimination in NLPs
+
+Copyright (c) 2023. Triad National Security, LLC. All rights reserved.
+
+This program was produced under U.S. Government contract 89233218CNA000001
+for Los Alamos National Laboratory (LANL), which is operated by Triad
+National Security, LLC for the U.S. Department of Energy/National Nuclear
+Security Administration. All rights in the program are reserved by Triad
+National Security, LLC, and the U.S. Department of Energy/National Nuclear
+Security Administration. The Government is granted for itself and others
+acting on its behalf a nonexclusive, paid-up, irrevocable worldwide license
+in this material to reproduce, prepare derivative works, distribute copies
+to the public, perform publicly and display publicly, and to permit others
+to do so.
+
+This software is distributed under the 3-clause BSD license.
+___________________________________________________________________________

Makefile

@@ -1,64 +1,8 @@
-# TODO: Variable for results dir and/or suffix
 DIR=var_elim/scripts
 COMDIR=commands
 RESDIR=results
 IMDIR=images
 
-all:
-	echo "WARNING: Reproducing all results in serial via `make all` is time-consuming."
-	echo "We recommend reproducing these results in an HPC environment with a resource"
-	echo "manager like Slurm, if available."
-	# Generate results for Table 3, Table 4, Figure 5, Figure 6, and Figure 7
-	python $(DIR)/analyze_structure.py
-	# Table 3
-	python $(DIR)/write_latex_table.py results/structure.csv
-	# Table 4
-	python $(DIR)/write_latex_table.py results/structure.csv --which=matching-bounds
-	# Figures 5 and 7
-	python $(DIR)/plot_structure_bargraphs.py results/structure.csv --image-dir=$(IMDIR)
-	# Figure 6
-	python $(DIR)/plot_sparsity.py --model=mb-steady --image-dir=$(IMDIR)
-	# Generate results for Figure 8 and Table 5
-	python $(DIR)/analyze_solvetime.py
-	# Table 5
-	python $(DIR)/write_latex_table.py results/solvetime.csv
-	# Figure 8
-	python $(DIR)/plot_timing_bargraphs.py results/solvetime.csv --image-dir=$(IMDIR)
-	# Generate results for Table 6 and Figures 9, 10, 11, and 12
-	python $(DIR)/run_param_sweep.py --model=distill
-	python $(DIR)/run_param_sweep.py --model=mb-steady
-	python $(DIR)/run_param_sweep.py --model=pipeline
-	# Table 6
-	python $(DIR)/summarize_sweep_results.py --model=distill
-	python $(DIR)/summarize_sweep_results.py --model=mb-steady
-	python $(DIR)/summarize_sweep_results.py --model=pipeline
-	#
-	# Each parameter sweep plot is produced individually...
-	# Figure 9
-	python $(DIR)/plot_sweep_results.py $(DIR)/results/sweep/distill-no-elim-sweep.csv
-	python $(DIR)/plot_sweep_results.py $(DIR)/results/sweep/distill-d1-sweep.csv
-	python $(DIR)/plot_sweep_results.py $(DIR)/results/sweep/distill-trivial-sweep.csv
-	python $(DIR)/plot_sweep_results.py $(DIR)/results/sweep/distill-linear-d2-sweep.csv
-	python $(DIR)/plot_sweep_results.py $(DIR)/results/sweep/distill-d2-sweep.csv
-	python $(DIR)/plot_sweep_results.py $(DIR)/results/sweep/distill-ampl-sweep.csv
-	python $(DIR)/plot_sweep_results.py $(DIR)/results/sweep/distill-matching-sweep.csv
-	# Figure 10
-	python $(DIR)/plot_sweep_results.py $(DIR)/results/sweep/mb-steady-no-elim-sweep.csv
-	python $(DIR)/plot_sweep_results.py $(DIR)/results/sweep/mb-steady-d1-sweep.csv
-	python $(DIR)/plot_sweep_results.py $(DIR)/results/sweep/mb-steady-trivial-sweep.csv
-	python $(DIR)/plot_sweep_results.py $(DIR)/results/sweep/mb-steady-linear-d2-sweep.csv
-	python $(DIR)/plot_sweep_results.py $(DIR)/results/sweep/mb-steady-d2-sweep.csv
-	python $(DIR)/plot_sweep_results.py $(DIR)/results/sweep/mb-steady-ampl-sweep.csv
-	python $(DIR)/plot_sweep_results.py $(DIR)/results/sweep/mb-steady-matching-sweep.csv
-	# Figure 11
-	python $(DIR)/plot_sweep_results.py $(DIR)/results/sweep/pipeline-no-elim-sweep.csv
-	python $(DIR)/plot_sweep_results.py $(DIR)/results/sweep/pipeline-d1-sweep.csv
-	python $(DIR)/plot_sweep_results.py $(DIR)/results/sweep/pipeline-trivial-sweep.csv
-	python $(DIR)/plot_sweep_results.py $(DIR)/results/sweep/pipeline-linear-d2-sweep.csv
-	python $(DIR)/plot_sweep_results.py $(DIR)/results/sweep/pipeline-d2-sweep.csv
-	python $(DIR)/plot_sweep_results.py $(DIR)/results/sweep/pipeline-ampl-sweep.csv
-	python $(DIR)/plot_sweep_results.py $(DIR)/results/sweep/pipeline-matching-sweep.csv
-
 structure-parallel:
 	mkdir -p $(RESDIR)/structure # Letting this get created by the parallel scripts below leads to a race condition
 	python $(DIR)/write_command_lines.py structure --results-dir=$(RESDIR) --commands-dir=$(COMDIR)
@@ -81,15 +25,18 @@ solvetime-collect:
 	python $(DIR)/plot_timing_bargraphs.py $(RESDIR)/solvetime.csv --image-dir=$(IMDIR)
 
 sweep-batch:
+	mkdir -p $(COMDIR)
 	mkdir -p $(RESDIR)/sweep
 	python $(DIR)/write_sweep_command_lines.py --results-dir=$(RESDIR)/sweep --commands-dir=$(COMDIR) --image-dir=$(IMDIR)
 	# This is a custom command I use to submit batch jobs on multiple HPC nodes
 	submit-batch.sh $(COMDIR)/parallel-sweep-commands.txt
 
 sweep-collect:
+	mkdir -p $(IMDIR)
 	parallel -a $(COMDIR)/collect-sweep-commands.txt
 	parallel -a $(COMDIR)/plot-sweep-commands.txt
 	python $(DIR)/summarize_sweep_results.py --results-dir=$(RESDIR)/sweep --model=distill
 	python $(DIR)/summarize_sweep_results.py --results-dir=$(RESDIR)/sweep --model=mb-steady
 	python $(DIR)/summarize_sweep_results.py --results-dir=$(RESDIR)/sweep --model=pipeline
+	python $(DIR)/summarize_sweep_results.py --results-dir=$(RESDIR)/sweep
 	python $(DIR)/write_latex_table.py $(RESDIR)/sweep-summary.csv --results-dir=$(RESDIR)