|
|
Arcane
4.1.12.0
User documentation
|
|
|
|
Arcane
4.1.12.0
User documentation
|
Compilation must be done in a directory different from the one containing the sources.
To retrieve the sources:
or
By default, Arcane and Alien are compiled if the prerequisites are available. The CMake variable ARCANEFRAMEWORK_BUILD_COMPONENTS contains the list of repository components to compile. This list can contain the following values:
By default, the value is Arcane;Alien, and thus both components are compiled. As they depend on Arccore, this component is also enabled.
To compile, you must proceed as follows:
By default, installation takes place in /usr/local if the CMAKE_INSTALL_PREFIX option is not specified.
General options:
| Option | Value | Description |
|---|---|---|
| CMAKE_INSTALL_PREFIX | /path/to/install | Choice of an installation directory |
| ARCANEFRAMEWORK_BUILD_COMPONENTS | Arcane or Alien or Arcane;Alien | Component(s) to compile |
| ARCCORE_CXX_STANDARD | 20 (the default), 23 or 26 | Choice of C++ standard to use |
| ARCCORE_ENABLE_MPI | ON (default) /OFF | Enable/Disable MPI support in Arccore |
| ARCCORE_ENABLE_TBB | ON (default) /OFF | Enable/Disable multi-threading support using OneTBBin Arccore |
| ARCCORE_ENABLE_TESTS | ON/OFF | Enable/Disable tests for Arccore |
| ARCANE_ENABLE_TESTS | ON/OFF | Enable/Disable tests for Arcane |
| ARCANE_ENABLE_DOTNET_WRAPPER | ON/OFF | Enable/Disable the C#/.Net wrapper |
| ARCANE_ENABLE_ALEPH | ON/OFF | Enable/Disable support for the Aleph component |
| Option | Value | Description |
|---|---|---|
| ARCANE_ACCELERATOR_MODE |
| Allows specifying the type of accelerator you wish to use. Starting from version 3.14 of Arcane, it is possible to use CUDA instead of CUDANVCC and ROCM instead of ROCMHIP |
| CMAKE_CUDA_COMPILER | CUDA compiler (example: nvcc or clang++) | Allows specifying the path to the historical CUDA compiler (nvcc) or another compiler supporting the ptx format |
| CMAKE_HIP_COMPILER | ROCM/HIP compiler (example: amdclang++ or clang++) | Allows specifying the path to the compiler used to generate code for ROCM/HIP |
| CMAKE_CUDA_ARCHITECTURES | Target architecture (example: 80) | Allows specifying a target architecture (Compute Capability). A list of multiple values is possible (for example 80;90) |
| CMAKE_HIP_ARCHITECTURES | Target architecture (example: gfx90a) | Allows specifying a target architecture for AMD GPUs. A list of values is possible (for example gfx90a;gfx1031) |
The CMake variable ARCANE_ACCELERATOR_MODE allows specifying the type of accelerator you wish to use. There are currently two supported values:
You must have at least version 12 of CUDA.
If you wish to compile CUDA support, you must add the argument -DARCANE_ACCELERATOR_MODE=CUDA to the configuration and specify the path to the nvcc or clang++ compiler via the CMake variable CMAKE_CUDA_COMPILER or the environment variable CUDACXX:
It is also possible to use the NVIDIA HPC SDK compiler directly:
It is possible to specify a target architecture (Compute Capability) via the CMAKE_CUDA_ARCHITECTURES variable, for example -DCMAKE_CUDA_ARCHITECTURES=80.
The minimum required ROCM version is 6.3. Older versions may compile but they are not tested.
To compile for AMD GPUs (such as the MI100 or MI250 GPUs), you must first install the ROCM library. When configuring Arcane, you must specify -DARCANE_ACCELERATOR_MODE=ROCMHIP.
For example, if ROCM is installed in /opt/rocm and you wish to compile for the MI250 cards (gfx90x architecture):
| Option | Value | Description |
|---|---|---|
| ARCANEDOC_OFFLINE | ON or OFF | Allows knowing if internet access is available |
| ARCANEDOC_LEGACY_THEME | ON or OFF | Allows generating the documentation with the original Doxygen style |
Documentation generation has only been tested on Linux platforms. It requires Doxygen.
If ARCANEDOC_OFFLINE=ON, Doxygen requires a LaTeX installation to correctly generate certain equations.
Depending on the platform, it may be necessary to install additional LaTeX packages (for example, the texlive-latex-extra package is required for Ubuntu).
For configuration, two optional options are available:
Each has two possible values: ON and OFF.
If the variables are not present, OFF is the default value.
Example:
The ARCANEDOC_LEGACY_THEME option allows generating the documentation with the original Doxygen theme.
The ARCANEDOC_OFFLINE option tells CMake that the documentation will be used locally, without internet access. This allows disabling elements that require internet access, such as MathJax.
Once the configuration is complete, simply run:
For user documentation:
For developer documentation
The user documentation only contains information on classes useful for the developer.
| Option | Value | Description |
|---|---|---|
| ARCANE_NO_DEFAULT_PACKAGE | TRUE or FALSE | Allows removing automatic package detection |
| ARCANE_REQUIRED_PACKAGE_LIST | Package name (example: LibUnwind;HDF5) | Allows explicitly specifying the packages you wish to have |
By default, all optional packages are automatically detected. It is possible to remove this behavior and disable automatic package detection by adding -DARCANE_NO_DEFAULT_PACKAGE=TRUE to the command line. In this case, you must explicitly specify the packages you wish to have by listing them in the ARCANE_REQUIRED_PACKAGE_LIST variable. For example, if you only want HDF5 and LibUnwind available, you must use CMake as follows:
1.16.1