Merge branch 'main' into gdgirard_10-partial-derivatives-of-a-2d-field

.github/workflows/deploy.yml

@@ -60,7 +60,7 @@ jobs:
         shell: bash
       - name: Generate docs
         run: |
-          cmake -DGYSELALIBXX_COMPILE_SOURCE=OFF -DBUILD_DOCUMENTATION=1 -B build-docs code_branch
+          cmake -DGYSELALIBXX_COMPILE_SOURCE=OFF -DGYSELALIBXX_BUILD_DOCUMENTATION=1 -B build-docs code_branch
           cmake --build build-docs
         shell: bash
       - name: Update documentation

.github/workflows/static_analyses.yml

@@ -99,11 +99,10 @@ jobs:
       - uses: actions/checkout@v4
         with:
           fetch-depth: 0
-          submodules: true
       - name: Make documenation
         run: |
           # Make docs
-          cmake -DGYSELALIBXX_BUILD_DOCUMENTATION=ON -B build -S .
+          cmake -DGYSELALIBXX_COMPILE_SOURCE=OFF -DGYSELALIBXX_BUILD_DOCUMENTATION=ON -B build -S .
           cmake --build build --target doc
         shell: bash
       - name: Check for new errors

README.md

@@ -21,9 +21,9 @@ cd gyselalibxx
 
 on a machine for which Gyselalib++ is already used an environment script may be available to set up the necessary modules etc.
 
-Please check the folder toolchains to find the existing configurations. See the documentation about [toolchains](./toolchains/README.md) for more information on the provided files.
+Please check the `toolchains/` folder to find the existing configurations. See the documentation about [toolchains](./toolchains/README.md) for more information on the provided files.
 
-For example in order to set up the environment on the Adastra supercalculator simply run:
+For example in order to set up the environment on the Adastra supercomputer simply run:
 ```
 source toolchains/mi250.hipcc.adastra.spack/prepare.sh
 source toolchains/mi250.hipcc.adastra.spack/environment.sh
@@ -61,7 +61,7 @@ and `tests/geometryXVx/landau/fft/frequency_t0.0to45.0.png`:
 
 ## Dependencies
 
-To install dependencies through spack, first follow the the 3 first steps of 
+To install dependencies through spack, first follow the the 3 first steps of
 https://github.com/pdidev/spack
 
 Then execute the following:
@@ -72,5 +72,5 @@ spack concretize --reuse
 spack install
 ```
 
-For example, you can find a Dockerfile installing these dependencies on ubuntu in 
+For example, you can find a Dockerfile installing these dependencies on ubuntu in
 `docker/gyselalibxx_env/Dockerfile`.

docs/DDC_in_gyselalibxx.md

@@ -164,12 +164,12 @@ or:
 ddc::for_each(idx_range, [&](Idx<GridX> index) {
 });
 ```
-In the case of a `ddc::for_each` the second argument is a lambda function. The `[&]` ensures that any variable defined outside the loop are captured by reference so they can be used inside the lamda function.
+In the case of a `ddc::for_each` the second argument is a lambda function. The `[&]` ensures that any variable defined outside the loop are captured by reference so they can be used inside the lambda function.
 
 It is also common to need to iterate over a subset of grid points. Such a subset can be created using the syntax described above, however `IdxRange` also contains several helper functions which are designed to facilitate the creation of these sets:
 - `take_first(IdxStep<..> n)` : Returns an index range containing only the first n indices of the original range.
 - `take_last(IdxStep<..> n)` : Returns an index range containing only the last n indices of the original range.
-- `remove_first(IdxStep<..> n)` : Returns an index range containing all but the first n indicie of the original range.
+- `remove_first(IdxStep<..> n)` : Returns an index range containing all but the first n indices of the original range.
 - `remove_last(IdxStep<..> n)` : Returns an index range containing all but the last n indices of the original range.
 - `remove(IdxStep<..> n_first, IdxStep<..> n_last)` : Returns an index range containing all indices of the original range except the first n\_first indices and the last n\_last indices.
 
@@ -194,7 +194,7 @@ In Gyselalibxx the alias `IdxRangeX` is usually defined in `geometry.hpp` to des
 
 Data is allocated at the instantiation of a `FieldMem` (type alias for `ddc::Chunk`). This type is parametrised by the underlying data type (e.g. `double`), and the `IdxRange` on which the values are defined. By default in Gysela memory is allocated on the device (GPU).
 
-In order to initialise the data storage to the correct size, a `FieldMem` is initailised by providing the `IdxRange` on which the values are defined.
+In order to initialise the data storage to the correct size, a `FieldMem` is initialised by providing the `IdxRange` on which the values are defined.
 
 In Gyselalibxx the alias `FieldMemX` is usually defined in `geometry.hpp` to describe the memory block for a field defined on the all or part of `GridX`.. E.g:
 ```cpp