You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: pages/docs/installation/installation-source-configuration.md
+7-7Lines changed: 7 additions & 7 deletions
Original file line number
Diff line number
Diff line change
@@ -39,27 +39,27 @@ Assemble your CMake command and run it to configure preCICE.
39
39
This example builds the release version of preCICE with the PETSc mapping and the user-defined python actions off, which will be installed in the prefix `~/software/precice`.
[`BUILD_SHARED_LIBS`](https://cmake.org/cmake/help/v3.10/variable/BUILD_SHARED_LIBS.html?highlight=build_shared_libs) | Boolean | ON | Build as a shared library.
[`CMAKE_INSTALL_PREFIX`](https://cmake.org/cmake/help/v3.10/variable/CMAKE_INSTALL_PREFIX.html) | Path | `/usr/local` | The prefix used in the installation step.
50
-
`PRECICE_MPICommunication` | Boolean | ON | Build with MPI.
50
+
`PRECICE_FEATURE_MPI_COMMUNICATION` | Boolean | ON | Build with MPI.
51
51
[`MPI_CXX_COMPILER`](https://cmake.org/cmake/help/v3.10/module/FindMPI.html#variables-for-locating-mpi) | Path | | MPI compiler wrapper to use for detection.
52
-
`PRECICE_PETScMapping` | Boolean | ON | Build with PETSc (for MPI-parallel RBF mapping), requires `PRECICE_MPICommunication=ON`.
53
-
`PRECICE_PythonActions` | Boolean | ON | Build support for python actions.
52
+
`PRECICE_FEATURE_PETSC_MAPPING` | Boolean | ON | Build with PETSc (for MPI-parallel RBF mapping), requires `PRECICE_FEATURE_MPI_COMMUNICATION=ON`.
53
+
`PRECICE_FEATURE_PYTHON_ACTIONS` | Boolean | ON | Build support for python actions.
54
54
`PYTHON_EXECUTABLE` | Path | | Path to the python interpreter to use.
55
55
[`BUILD_TESTING`](https://cmake.org/cmake/help/v3.10/module/CTest.html#module:CTest) | Boolean | ON | Build and register the tests.
56
56
`PRECICE_RELEASE_WITH_ASSERTIONS` | Boolean | OFF | Enables assertions in release builds.
57
57
`PRECICE_RELEASE_WITH_DEBUG_LOG` | Boolean | OFF | Enables debug logging in release builds.
58
58
`PRECICE_RELEASE_WITH_TRACE_LOG` | Boolean | OFF | Enables trace logging in release builds.
59
59
`PRECICE_InstallTest` | Boolean | OFF | Install `testprecice` and test configuration files.
60
-
`PRECICE_Packages` | Boolean | ON | Enable package configuration.
61
-
`PRECICE_ENABLE_C` | Boolean | ON | Enable the native C bindings.
62
-
`PRECICE_ENABLE_FORTRAN` | Boolean | ON | Enable the native Fortran bindings.
60
+
`PRECICE_CONFIGURE_PACKAGE_GENERATION` | Boolean | ON | Enable package configuration.
61
+
`PRECICE_BINDINGS_C` | Boolean | ON | Enable the native C bindings.
62
+
`PRECICE_BINDINGS_FORTRAN` | Boolean | ON | Enable the native Fortran bindings.
63
63
`PRECICE_ALWAYS_VALIDATE_LIBS` | Boolean | OFF | Force CMake to always validate required libraries.
64
64
`PRECICE_TEST_TIMEOUT_LONG` | Integer | 180 | Timeout for big test suites
65
65
`PRECICE_TEST_TIMEOUT_SHORT` | Integer | 20 | Timeout for small test suites
Copy file name to clipboardExpand all lines: pages/docs/installation/installation-source-dependencies.md
+9-9Lines changed: 9 additions & 9 deletions
Original file line number
Diff line number
Diff line change
@@ -205,7 +205,7 @@ Please double check if there are no system packages before attempting to build t
205
205
| Required | 3.6 | 3.12 |
206
206
| Incompatible | 3.12 | <- |
207
207
208
-
[PETSc](https://www.mcs.anl.gov/petsc/) is used for RBF mappings and is highly recommended for large cases. For small/medium-size cases, preCICE can still do an RBF mapping in parallel without PETSc. If you don't need this feature, you may specify `-DPRECICE_PETScMapping=off` when building preCICE.
208
+
[PETSc](https://www.mcs.anl.gov/petsc/) is used for RBF mappings and is highly recommended for large cases. For small/medium-size cases, preCICE can still do an RBF mapping in parallel without PETSc. If you don't need this feature, you may specify `-DPRECICE_FEATURE_PETSC_MAPPING=off` when building preCICE.
209
209
210
210
We require at least version 3.12. For preCICE versions earlier than v2.1.0, PETSc version between 3.6 and 3.12 might still work, but needs to be built with 64bit index sizes. In particular on [Ubuntu 18.04, we require at least 3.12](https://github.com/precice/precice/issues/115).
211
211
@@ -236,7 +236,7 @@ Finally, in some cases you may need to have PETSc in your `CPATH`, `LIBRARY_PATH
236
236
| Required NumPy || 1.17 |
237
237
| Incompatible NumPy | 1.17 | None |
238
238
239
-
You only need [Python](https://www.python.org/) if you want to use the Python action interface (only used for rare applications). If you don't need this feature, you may specify `-DPRECICE_PythonActions=off`.
239
+
You only need [Python](https://www.python.org/) if you want to use the Python action interface (only used for rare applications). If you don't need this feature, you may specify `-DPRECICE_FEATURE_PYTHON_ACTIONS=off`.
240
240
In particular, you don't need to build with Python if you only want to use the [preCICE Python bindings](installation-bindings-python.html).
241
241
242
242
You probably already have Python installed. However, in order to use the Python interface, you also need to install NumPy and the header files for Python and NumPy. On Debian/Ubuntu, install the packages `python3-numpy` and `python3-dev`.
@@ -245,7 +245,7 @@ You probably already have Python installed. However, in order to use the Python
245
245
246
246
preCICE requires an implementation of the MPI-3 specification, which is provided by all major vendors including OpenMPI, MPICH, and Intel MPI.
247
247
248
-
You can build preCICE without [MPI](https://en.wikipedia.org/wiki/Message_Passing_Interface#Official_implementations) in case of compatibility issues with a certain solver (e.g. a closed source solver with a binary-distributed MPI version, or when running on Windows). To do so, use `-DPRECICE_MPICommunication=OFF` when building with CMake. In such a case, you can still use TCP/IP sockets instead. This might, however, result in lower performance and is, therefore, not recommended if not necessary.
248
+
You can build preCICE without [MPI](https://en.wikipedia.org/wiki/Message_Passing_Interface#Official_implementations) in case of compatibility issues with a certain solver (e.g. a closed source solver with a binary-distributed MPI version, or when running on Windows). To do so, use `-DPRECICE_FEATURE_MPI_COMMUNICATION=OFF` when building with CMake. In such a case, you can still use TCP/IP sockets instead. This might, however, result in lower performance and is, therefore, not recommended if not necessary.
249
249
250
250
Please note that many MPI implementations implement the client-server functionality in various ways.
251
251
They often require special setup such as environment variables, servers or infrastructure setup.
If you don't plan to use RBF mappings in large parallel cases you can continue without installing PETSc and build with `-DPRECICE_PETScMapping=OFF`.
294
+
If you don't plan to use RBF mappings in large parallel cases you can continue without installing PETSc and build with `-DPRECICE_FEATURE_PETSC_MAPPING=OFF`.
295
295
If you need PETSc, follow the steps in the [PETSc](#petsc) section and you are done.
If you don't plan to use RBF mappings in large parallel cases you can continue without installing PETSc and build with `-DPRECICE_PETScMapping=OFF`.
317
+
If you don't plan to use RBF mappings in large parallel cases you can continue without installing PETSc and build with `-DPRECICE_FEATURE_PETSC_MAPPING=OFF`.
318
318
If you need PETSc, follow the steps in the [PETSc](#petsc) section and you are done.
In case you use the docker image of fedora, you need to install the support for environment modules first: `sudo dnf install environment-modules`
341
341
{% endnote %}
342
342
343
-
If you don't plan to use RBF mappings in large parallel cases you can continue without installing PETSc and build with `-DPRECICE_PETScMapping=OFF`. You may need this with older preCICE and Fedora versions (e.g. preCICE v2.1 on Fedora 32 or earlier, see a [related issue](https://github.com/precice/precice/issues/864).
343
+
If you don't plan to use RBF mappings in large parallel cases you can continue without installing PETSc and build with `-DPRECICE_FEATURE_PETSC_MAPPING=OFF`. You may need this with older preCICE and Fedora versions (e.g. preCICE v2.1 on Fedora 32 or earlier, see a [related issue](https://github.com/precice/precice/issues/864).
344
344
345
345
### Rocky Linux 9
346
346
@@ -366,7 +366,7 @@ Rocky Linux very closely follows the conventions previously set by CentOS. We fi
366
366
module load mpi/openmpi-x86_64
367
367
```
368
368
369
-
4. Unfortunately, [PETSc does not seem to be available in this distribution.](https://pkgs.org/search/?q=petsc), so we need to switch that off later when building preCICE. If you don't plan to use RBF mappings in large parallel cases, you can continue without installing PETSc and build preCICE with `-DPRECICE_PETScMapping=OFF`. If you need PETSc, follow the steps in the [PETSc](#petsc) section and you are done.
369
+
4. Unfortunately, [PETSc does not seem to be available in this distribution.](https://pkgs.org/search/?q=petsc), so we need to switch that off later when building preCICE. If you don't plan to use RBF mappings in large parallel cases, you can continue without installing PETSc and build preCICE with `-DPRECICE_FEATURE_PETSC_MAPPING=OFF`. If you need PETSc, follow the steps in the [PETSc](#petsc) section and you are done.
370
370
371
371
### CentOS 8
372
372
@@ -404,7 +404,7 @@ This system requires to install some tools in a fixed order.
404
404
module load mpi/openmpi-x86_64
405
405
```
406
406
407
-
4. Unfortunately, the PETSc package (`petsc-openmpi-devel`) in this distribution is too old. If you don't plan to use RBF mappings in large parallel cases you can continue without installing PETSc, and build preCICE with `-DPRECICE_PETScMapping=OFF`. If you need PETSc, follow the steps in the [PETSc](#petsc) section and you are done.
407
+
4. Unfortunately, the PETSc package (`petsc-openmpi-devel`) in this distribution is too old. If you don't plan to use RBF mappings in large parallel cases you can continue without installing PETSc, and build preCICE with `-DPRECICE_FEATURE_PETSC_MAPPING=OFF`. If you need PETSc, follow the steps in the [PETSc](#petsc) section and you are done.
408
408
409
409
### CentOS 7
410
410
@@ -474,7 +474,7 @@ cmake -DEIGEN3_INCLUDE_DIR=/usr/include/eigen3 <options as usual>
474
474
If you don't already have a fitting combination of MPI and PETSc (not shown here), disable the respective features when configuring preCICE:
475
475
476
476
```bash
477
-
cmake -DPRECICE_MPICommunication=OFF -DPRECICE_PETScMapping=OFF <options as usual>
477
+
cmake -DPRECICE_FEATURE_MPI_COMMUNICATION=OFF -DPRECICE_FEATURE_PETSC_MAPPING=OFF <options as usual>
478
478
```
479
479
480
480
See also a related [discussion on the preCICE forum](https://precice.discourse.group/t/compiling-precice-on-opensuse-leap/1148/4) for more details.
0 commit comments