Installation and Dependencies#
Installation#
Tip
pressio-ops is header-only, so it does not need to be precompiled and linked to. However, since we use preprocessor directives to conditionally enable/disable code based on target third-party libraries, one needs to account for this. See below for the details.
Warning
To use pressio-ops, you need at least a C++17 compiler.
Dependencies#
Some parts contain code that are specific to third-party libraries (TPLs). Currently, the list of TPLs supported is shown below:
TPL Name |
Optional/Required |
Version Known to Work/run in CI |
---|---|---|
Eigen |
Required |
3.3.7 |
Trilinos |
Optional |
commit: ef73d14babf6e7556b0420add98cce257ccaa56b |
MPI |
Optional |
– |
Kokkos |
Optional |
3.1.0 |
BLAS |
Optional |
– |
LAPACK |
Optional |
– |
GoogleTest |
Optional |
1.10.0 |
Eigen is the only required dependency because it is the default choice for instantiating the ROM data structures and solving the (dense) ROM problem used in pressio.
CMake Keywords#
Enabling/disabling specific dependencies can be done via the following cmake variables:
Variable |
Description |
Default |
---|---|---|
|
self-explanatory |
|
|
self-explanatory |
|
|
self-explanatory |
|
|
self-explanatory |
|
|
self-explanatory |
|
Obviously, the choice of which TPLs to enable is related to
your application’s dependency requirements.
For example, if you have an application that relies on
Trilinos data structures and want to use pressio
,
then it makes sense to enable the Trilinos dependency.
On the contrary, if you have an application that relies only on
Eigen data structures, then it makes sense to only leave only Eigen on
and disable the rest.
Also, we note that some of the cmake variables listed above are connected
and cannot be turned on individualy.
For example, if we enable Trilinos then pressio
automatically
enables also Kokkos, BLAS, LAPACK and MPI.
Important
All CMake keywords are prefixed with PRESSIO_
which is case-sensitive.
Recall that to set a keyword in CMake you used the syntax -Dkeyword_name
.