Commit 1373c930 authored by Thomas Purcell's avatar Thomas Purcell
Browse files

Add note about make clean in Installation.md

Used in case a compilation fails because external library conflicts
parent 431f48ad
......@@ -82,8 +82,13 @@ make install
Once all the commands are run `SISSO++` should be in the `~/SISSO++/main directory/bin/` directory.
#### Install the Binary Without the Python Bindings
To install only the `SISSO++` executable repeat the same commands as above but set `USE_PYTHON` in `initial_config.cmake` to `OFF`.
#### 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`
......@@ -104,7 +109,7 @@ Define the flags used by the compiler to build the C source files (GTest and {fm
#### `CMAKE_INSTALL_PREFIX`
Default: SISSO++ Source Directory
*Default: SISSO++ Source Directory*
Path to where the final library and executable files will be placed
......@@ -112,25 +117,25 @@ Path to where the final library and executable files will be placed
#### `BUILD_PARAMS`
Default: OFF
*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`
Default: ON
*Default: ON*
If `BUILD_PYTHON` is ON then build the python bindings
#### `BUILD_TESTS`
Default: OFF
*Default: OFF*
If `BULD_TESTS` is ON then build GTest based tests
#### `EXTERNAL_BOOST`
Default: OFF
*Default: OFF*
If `EXTERNAL_BOOST` is ON then use the pre-built Boost Libraries currently in your path or in `$ENV{BOOST_ROOT}`
Here the `-O3` flag is for optimizations, it is recommended to stay as `-O3` or `-O2`, but it can be changed to match compiler requirements.
......@@ -139,6 +144,8 @@ We recommend to use `-DEXTERNAL_BOOST=OFF` if you are building the python bindin
#### EXTERNAL_BUILD_N_PROCS
Default: 1
*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