consolidated scripts dir

Author: James-Oswald

README.md

@@ -36,6 +36,17 @@ More on Args:
 * OzSerial - Recursive DP O(n) layer mapping algo run on each rank
 * MPI - MPI parallel D(n) layer mapping algo
 
+## Project Layout
+* `.github` : github actions for testing proofs
+* `.vscode` : vscode recommended extensions and settings for the project
+* `benchmarks` : quick benchmarking utilities to measure performance
+* `proofs` : Proof files to verify on
+  * `hyperslate` : hyperslate slt proofs
+  * `lazyslate` : lazyslate json proofs
+* `sandbox` : code to test features to implement 
+* `scripts` : utility scripts for debugging, building, etc
+* `src` : Source Code
+* `tests` : CTest suite
 
 ## Dependencies
 * [MPI](https://www.open-mpi.org/) (We use Open-MPI for local debugging and MPICH for benchmarks)

build-release.sh

@@ -5,9 +5,9 @@
 # and copies our executables into bin
 
 set -e
-SCRIPTDIR="$( cd -- "$(dirname "$0")" >/dev/null 2>&1 ; pwd -P )"
-mkdir -p $SCRIPTDIR/build
-cd $SCRIPTDIR/build
+ROOTDIR="../$( cd -- "$(dirname "$0")" >/dev/null 2>&1 ; pwd -P )"
+mkdir -p $ROOTDIR/build
+cd $ROOTDIR/build
 cmake ../ -D CMAKE_BUILD_TYPE=Debug
 make
-cd $SCRIPTDIR
+cd $ROOTDIR

debugParallel.sh

@@ -0,0 +1,11 @@
+
+# Cmake wrapper script that Automatically runs all the CMake Build
+# and copies our executables into bin
+
+set -e
+ROOTDIR="../$( cd -- "$(dirname "$0")" >/dev/null 2>&1 ; pwd -P )"
+mkdir -p $ROOTDIR/build
+cd $ROOTDIR/build
+cmake ../
+make
+cd $ROOTDIR

build-debug.sh renamed to scripts/build-debug.sh

@@ -0,0 +1,4 @@
+
+# Run the debugger
+ROOTDIR="../$( cd -- "$(dirname "$0")" >/dev/null 2>&1 ; pwd -P )"
+mpirun -n 2 xterm -hold -e gdb -ex run --args $ROOTDIR/build/bin/ParallelVerifier $ROOTDIR/proofs/lazyslate/ourFavorite.json

scripts/build-release.sh

@@ -0,0 +1,3 @@
+
+cmake -B ../build/ cmake --graphviz=../build/depGraph.dot ..
+dot -Tpng -o depGraph.png ../build/depGraph.dot