Added an offline mode option to batch.py

* Added a decription of offline IPC mode to the README
* Fixed IPC_bin's log when OpenGL is disabled and not offline mode

Author: zfergus

README.md

@@ -22,7 +22,13 @@ This is the opensource reference implementation of the SIGGRAPH 2020 paper [Incr
 
 ## Build
 
-* `python build.py`
+You can either use `python build.py` or
+```
+mkdir build
+cd build
+cmake -DCMAKE_BUILD_TYPE=Release ..
+make -j4
+```
 
 ### Dependancies
 
@@ -40,6 +46,10 @@ installed at a system level
     * IPC also supports using [Eigen](http://eigen.tuxfamily.org/) or [AMGCL](https://github.com/ddemidov/amgcl) as linear solver, which can be set via `IPC_LINSYSSOLVER` in `CMakeLists.txt`. To use custom linear solvers, you can implement a new interface (subclass) to our `LinSysSolver` class.
 * [libigl](https://libigl.github.io/), [OSQP](https://osqp.org/), [AMGCL](https://github.com/ddemidov/amgcl), and [TBB](https://software.intel.com/content/www/us/en/develop/tools/threading-building-blocks.html): downloaded and built through CMake
 
+### Without OpenGL
+
+If your system does not have the required OpenGL libraries, you can disable the viewer using the CMake argument `-DIPC_WITH_OPENGL=OFF`. It is important to then run IPC in offline mode (see below).
+
 ### 2D?
 
 IPC is only implemented for 3D simulation.
@@ -71,6 +81,12 @@ of the sub-project (e.g. `DIAGNOSTIC`, `MESH_PROCESSING`). You can also set thes
 
 Please see our [quick start guide](https://github.com/ipc-sim/IPC/wiki) for a `hello world` example with various settings. The output of each script will be saved into a separate folder in `output/`.
 
+### Offline Mode
+
+It is possible to run IPC with and without the viewer. By default, the `batch.py` script runs IPC with the viewer. If you provide the argument `--offline` to `batch.py` then it will run IPC in offline mode (i.e. without the viewer).
+
+If you are running the `IPC_bin` executable directly then the first argument controls the mode. Mode `10` runs IPC with the viewer and is the default in the `batch.py`. Mode `100` runs IPC in offline mode (without the viewer). See `IPC_bin --help` for more detail.
+
 ### HPC
 
 From the IPC root directory use `sbatch run.sh` to processes all the input

batch.py

@@ -4,6 +4,13 @@
 from os import listdir
 from os.path import isfile, join
 
+import argparse
+
+parser = argparse.ArgumentParser(description='Batch proccess IPC sims.')
+parser.add_argument(
+    "--offline", help="run IPC without the viewer", action='store_true')
+args = parser.parse_args()
+
 inputFolderPath = os.path.realpath('.') + '/input/'
 # on Mac:
 # progPath = os.path.realpath('.') + '/build/Release/IPC_bin'
@@ -14,19 +21,26 @@
 # progPath = os.path.realpath('.') + '/src/Projects/DistortionMin/DistortionMin'
 
 # envSetStr = 'export LD_LIBRARY_PATH=/usr/local/lib\n'
-NTSetStr0 = 'export MKL_NUM_THREADS='  # for Ubuntu or Mac when CHOLMOD is compiled with MKL LAPACK and BLAS
-NTSetStr1 = 'export OMP_NUM_THREADS='  # for Ubuntu when CHOLMOD is compiled with libopenblas
-NTSetStr2 = 'export VECLIB_MAXIMUM_THREADS='  # for Mac when CHOLMOD is compiled with default LAPACK and BLAS
+# for Ubuntu or Mac when CHOLMOD is compiled with MKL LAPACK and BLAS
+NTSetStr0 = 'export MKL_NUM_THREADS='
+# for Ubuntu when CHOLMOD is compiled with libopenblas
+NTSetStr1 = 'export OMP_NUM_THREADS='
+# for Mac when CHOLMOD is compiled with default LAPACK and BLAS
+NTSetStr2 = 'export VECLIB_MAXIMUM_THREADS='
 
 for numOfThreads in ['1', '8', '12']:
     inputFolderPath = os.path.realpath('.') + '/input/' + numOfThreads + '/'
+    if(not os.path.isdir(inputFolderPath)):
+        continue
     onlyfiles = [
         f for f in listdir(inputFolderPath) if isfile(join(inputFolderPath, f))
     ]
     for inputModelNameI in onlyfiles:
         runCommand = NTSetStr0 + numOfThreads + '\n'
         runCommand += NTSetStr1 + numOfThreads + '\n'
         runCommand += NTSetStr2 + numOfThreads + '\n'
-        runCommand += progPath + ' 10 ' + inputFolderPath + inputModelNameI + ' t' + numOfThreads
+        runCommand += "{} {} {} t{}".format(
+            progPath, '100' if args.offline else '10',
+            inputFolderPath + inputModelNameI, numOfThreads)
         if subprocess.call([runCommand], shell=True):
             continue

src/main.cpp

@@ -607,11 +607,9 @@ bool preDrawFunc()
 }
 
 struct CLIArgs {
-    int progMode = 0;
-    std::string meshFileName = "cone2.0.obj";
-    double lambda = 0.0;
-    double delta = 4.0;
-    std::string folderTail = "";
+    int progMode;
+    std::string inputFileName;
+    std::string folderTail;
     int logLevel = 0; // trace (all logs)
 };
 
@@ -621,7 +619,7 @@ void init_cli_app(CLI::App& app, CLIArgs& args)
         "program mode 0=optimization, 10=auto-switch, "
         "11=auto-switch (save png), 100=offline",
         true);
-    app.add_option("meshFileName", args.meshFileName, "input file name", true);
+    app.add_option("inputFileName", args.inputFileName, "input file name", true);
     app.add_option(
         "folderTail", args.folderTail, "output folder name tail/suffix", true);
     app.add_set("--logLevel,--log", args.logLevel, { 0, 1, 2, 3, 4, 5, 6 },
@@ -686,15 +684,15 @@ int main(int argc, char* argv[])
 
     // Optimization mode
     std::string meshFilePath;
-    if (args.meshFileName.at(0) == '/') {
+    if (args.inputFileName.at(0) == '/') {
         spdlog::info("The input script file name is gloabl mesh file path.");
-        meshFilePath = args.meshFileName;
-        args.meshFileName = args.meshFileName.substr(args.meshFileName.find_last_of('/') + 1);
+        meshFilePath = args.inputFileName;
+        args.inputFileName = args.inputFileName.substr(args.inputFileName.find_last_of('/') + 1);
     }
     else {
-        meshFilePath = args.meshFileName;
+        meshFilePath = args.inputFileName;
     }
-    std::string meshName = args.meshFileName.substr(0, args.meshFileName.find_last_of('.'));
+    std::string meshName = args.inputFileName.substr(0, args.inputFileName.find_last_of('.'));
     // Load mesh
     Eigen::MatrixXd V, UV, N;
     Eigen::MatrixXi F, FUV, FN, E;
@@ -1222,7 +1220,7 @@ int main(int argc, char* argv[])
 #endif
         viewer.launch();
 #else
-        spdlog::critical("Not offiline mode supported only with opengl");
+        spdlog::critical("Only offline mode is supported when OpenGL is disabled. See --help for more details.");
 #endif
     }