From 7ba977ac84cebd23002817cb5ea4d29e5b2ec6d4 Mon Sep 17 00:00:00 2001 From: c-goen <105125661+Gon-na@users.noreply.github.com> Date: Thu, 26 Oct 2023 11:57:40 +0200 Subject: [PATCH] Added documentation differences from main --- source/compiling.rst | 4 ++-- source/examples.rst | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/source/compiling.rst b/source/compiling.rst index 21e64cc26..1be937085 100644 --- a/source/compiling.rst +++ b/source/compiling.rst @@ -360,7 +360,7 @@ of the software. This optional dependencies are configurable through the cmake G optional settings require additional libraries or special hardware in order to operate. The use of some external libraries, (e.g. ROOT_ and VTK_) is collectively toggled for all sub-modules at once. The -*Kassiopeia* simulation software can link against these libraries using the *Kasper* flags outlined in the table below: +*Kassiopeia* simulation software can link against these libraries using the *KASPER* flags outlined in the table below: +---------------------------------------------------------------------------------------------------------+ | Collective options | @@ -371,7 +371,7 @@ The use of some external libraries, (e.g. ROOT_ and VTK_) is collectively toggle +--------------------+---------------------------------------+--------------------------------------------+ | KASPER_USE_BOOST | Boost_ developer libraries | Build Boost dependent extensions. | +--------------------+---------------------------------------+--------------------------------------------+ -| KASPER_USE_GSL | The GNU scientific library (GSL_) | Build GSL dependent extensions | +| KASPER_USE_GSL | The GNU scientific library (GSL_) | Build GSL dependent extensions. | +--------------------+---------------------------------------+--------------------------------------------+ | KASPER_USE_ROOT | The CERN ROOT_ libraries | Build ROOT dependent extensions. | +--------------------+---------------------------------------+--------------------------------------------+ diff --git a/source/examples.rst b/source/examples.rst index d820a6218..7aa9c29f4 100644 --- a/source/examples.rst +++ b/source/examples.rst @@ -173,7 +173,7 @@ of particle tracking in a photomultiplier tube is also included. This convifurat Since the dimensions of the linear system that needs to be solved in order to compute the electric field is rather large (~150K mesh elements), the initialization of the electric field may take some time. If the user has the appropriate device (e.g. a GPU) it is recommended that the field solving sub-module *KEMField* is augmented with OpenCL in order to -take advantage of hardware acceleration. This is done by setting the ``KEMField_USE_OpenCL`` flag in the build stage. +take advantage of hardware acceleration. This is done by setting the ``KEMField_USE_OPENCL`` flag in the build stage. To run this simulation, type: