Skip to content
Snippets Groups Projects
Commit 137a4e6a authored by Thomas Purcell's avatar Thomas Purcell
Browse files

Add fields for each install setting to the Installation.md page

Make that clear for everyone
parent dda6e01b
Branches
No related tags found
No related merge requests found
......@@ -21,9 +21,29 @@ To build the optional python bindings the following are also needed:
- Python 3.6 or greater
### Installation Settings
#### `BUILD_PARAMS`
If `BUILD_PARAMS` is ON then build the operators with non-linearly optimized scale and shift parameters, and the relevant optimization files
#### `BUILD_PYTHON`
If `BUILD_PYTHON` is ON then build the python bindings
#### `BUILD_TESTS`
If `BULD_TESTS` is ON then build GTest based tests
#### `EXTERNAL_BOOST`
If `EXTERNAL_BOOST` is ON then use the pre-built Boost Libraries currently in your path or in `$ENV{BOOST_ROOT}`
### Installing `SISSO++`
`SISSO++` is installed using a cmake build system, with sample configuration files located in `cmake/toolchains/`
For example, here is `initial_config.cmake` file used to construct `SISSO++` and the python bindings using the gnu compiler.
```
###############
# Basic Flags #
......@@ -38,14 +58,17 @@ set(CMAKE_CXX_FLAGS "-O3 -march=native" CACHE STRING "")
set(BUILD_PYTHON ON CACHE BOOL "")
set(BUILD_PARAMS ON CACHE BOOL "")
```
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.
When building Boost from source (`EXTERNAL_BOOST OFF`) the number of processes used when building Boost may be set using the
`BOOST_BUILD_N_PROCS` flag in CMake. For example, to build Boost using 4 processes, the following flag should be included in the
`initial_config.cmake` file:
```
#set(BOOST_BUILD_N_PROCS 4 CACHE STRING "")
```
This flag will have no effect when linking against external boost, i.e. `EXTERNAL_BOOST ON`.
To install `SISSO++` using `initial_config.cmake` run the following commands (this assumes gnu compiler and MKL are used, if you are using a different compiler/BLAS library change the flags to the relevant directories)
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment