Commit f54c6b2d authored by Thomas Purcell's avatar Thomas Purcell
Browse files

Update installation.md

Include make test
Match code_ref color scheme
parent f2d5c252
......@@ -85,29 +85,76 @@ Once all the commands are run `SISSO++` should be in the `~/SISSO++/main directo
To install only the `SISSO++` executable repeat the same commands as above but set `USE_PYTHON` in `initial_config.cmake` to `OFF`.
#### Testing the Compilation
To test the compilation of `SISSO++` run `make test` and you should get the following output
```
Test project /home/purcell/git/cpp_sisso/build
Start 1: Classification
1/17 Test #1: Classification ........................................... Passed 1.74 sec
Start 2: Classification_Max_Correlation_NE_One
2/17 Test #2: Classification_Max_Correlation_NE_One .................... Passed 0.55 sec
Start 3: Classification_Generate_Project
3/17 Test #3: Classification_Generate_Project .......................... Passed 0.55 sec
Start 4: Classification_Max_Correlation_NE_One_Generate_Project
4/17 Test #4: Classification_Max_Correlation_NE_One_Generate_Project ... Passed 0.54 sec
Start 5: Regression
5/17 Test #5: Regression ............................................... Passed 0.38 sec
Start 6: Generate_Project
6/17 Test #6: Generate_Project ......................................... Passed 0.38 sec
Start 7: Maximum_Correlation_NE_One
7/17 Test #7: Maximum_Correlation_NE_One ............................... Passed 0.43 sec
Start 8: Maximum_Correlation_NE_One_Generate_Project
8/17 Test #8: Maximum_Correlation_NE_One_Generate_Project .............. Passed 0.39 sec
Start 9: Log_Regression
9/17 Test #9: Log_Regression ........................................... Passed 0.37 sec
Start 10: Log_Regression_Max_Correlation_NE_One
10/17 Test #10: Log_Regression_Max_Correlation_NE_One .................... Passed 0.37 sec
Start 11: Log_Regression_Generate_Project
11/17 Test #11: Log_Regression_Generate_Project .......................... Passed 0.39 sec
Start 12: Log_Regression_Max_Correlation_NE_One_Generate_Project
12/17 Test #12: Log_Regression_Max_Correlation_NE_One_Generate_Project ... Passed 0.40 sec
Start 13: NL_Optimization
13/17 Test #13: NL_Optimization .......................................... Passed 3.06 sec
Start 14: NL_Optimization_Residuals
14/17 Test #14: NL_Optimization_Residuals ................................ Passed 9.66 sec
Start 15: NL_Optimization_Residuals_Generate_Project
15/17 Test #15: NL_Optimization_Residuals_Generate_Project ............... Passed 3.04 sec
Start 16: Python_Bindings
16/17 Test #16: Python_Bindings .......................................... Passed 12.49 sec
Start 17: CPP_Unit_Tests
17/17 Test #17: CPP_Unit_Tests ........................................... Passed 12.13 sec
100% tests passed, 0 tests failed out of 17
Total Test time (real) = 46.87 sec
```
Note the total test time may vary based on optimizations and computational resources used
#### Cleaning up Installation Files
To remove all previously built library and executable files run `make clean` in the build directory. If a compilation error occurs because of issues with one of the external libraries, then clean the build and recompile.
### Installation Settings for Basic Flags
#### `CMAKE_CXX_COMPILER`
#### <span style="color:red"> CMAKE_CXX_COMPILER </span>
The C++ compiler used to compile the code
#### `CMAKE_C_COMPILER`
#### CMAKE_C_COMPILER
The C compiler used to compile external dependencies (GTest and {fmt})
#### `CMAKE_CXX_FLAGS`
#### <span style="color:red"> CMAKE_CXX_FLAGS </span>
Define the flags used by the compiler to build the C++ source files. It is recommended to use `-O2` or `-O3` level of optimizations, but it can be changed to match the compiler.
#### `CMAKE_C_FLAGS`
#### CMAKE_C_FLAGS
Define the flags used by the compiler to build the C source files (GTest and {fmt}). It is recommended to use `-O2` or `-O3` level of optimizations, but it can be changed to match the compiler.
#### `CMAKE_INSTALL_PREFIX`
#### <span style="color:blue"> CMAKE_INSTALL_PREFIX </span>
*Default: SISSO++ Source Directory*
......@@ -115,25 +162,25 @@ Path to where the final library and executable files will be placed
### Installation Settings
#### `BUILD_PARAMS`
#### <span style="color:blue"> BUILD_PARAMS </span>
*Default: OFF*
If `BUILD_PARAMS` is ON then build the operators with non-linearly optimized scale and shift parameters, and the relevant optimization files. With this flag on `NLopt`, [the parameterized operators](../cpp_api/param_node), and [the non-linear optimization](../cpp_api/nl_opt) classes will be built.
#### `BUILD_PYTHON`
#### <span style="color:blue"> BUILD_PYTHON </span>
*Default: ON*
If `BUILD_PYTHON` is ON then build the python bindings
#### `BUILD_TESTS`
#### BUILD_TESTS
*Default: OFF*
If `BULD_TESTS` is ON then build GTest based tests
#### `EXTERNAL_BOOST`
#### EXTERNAL_BOOST
*Default: OFF*
......@@ -147,5 +194,3 @@ We recommend to use `-DEXTERNAL_BOOST=OFF` if you are building the python bindin
*Default: 1*
The number of processes passed to make when building external libraries.
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment