Merge branch 'm8_release_docs' into 'master'

M8 release docs for M8.03

See merge request giacomo.mulas/np_tmcode!50

.gitlab-ci.yml

@@ -92,7 +92,7 @@ building_stage:
       - cat /etc/os-release
       - cd src
       - echo "Running make with default compilers..."
-      - make clean && make -j
+      - make clean && USE_LAPACK=1 USE_ILP64=1 make -j
       - make docs -j && make -C ../doc/build/latex -j
 
 running_stage:
@@ -154,18 +154,18 @@ testing_stage:
       - cd build/sphere
       - export FFILE=../../test_data/sphere/OSPH
       - echo "Comparing output of SPHERE"
-      - python3 ../../src/scripts/pycompare.py --ffile=$FFILE --cfile=c_OSPH --html
+      - python3 ../../src/scripts/pycompare.py --no-progress --ffile=$FFILE --cfile=c_OSPH --html
       - echo "Checking consistency among legacy and HDF5 configuration files"
       - ../testing/test_TEDF ../../test_data/sphere/DEDFB c_TEDF c_TEDF.hd5
       - cd ../cluster
       - echo "Comparing output of CLUSTER"
       - export FFILE=../../test_data/cluster/OCLU
-      - python3 ../../src/scripts/pycompare.py --ffile=$FFILE --cfile=c_OCLU --html
+      - python3 ../../src/scripts/pycompare.py --no-progress --ffile=$FFILE --cfile=c_OCLU --html
       - echo "Testing cluster with 24 spheres"
       - ./np_cluster ../../test_data/cluster/DEDFB_24 ../../test_data/cluster/DCLU_24 .
       - echo "Comparing output of CLUSTER with 24 spheres"
       - export FFILE=../../test_data/cluster/OCLU_24
-      - python3 ../../src/scripts/pycompare.py --ffile=$FFILE --cfile=c_OCLU --html
+      - python3 ../../src/scripts/pycompare.py --no-progress --ffile=$FFILE --cfile=c_OCLU --html
       - echo "Checking consistency among legacy and HDF5 configuration files"
       - ../testing/test_TEDF ../../test_data/cluster/DEDFB_24 c_TEDF c_TEDF.hd5
       - echo "Checking consistency among legacy and HDF5 TM files"

containers/docker/README.md

 # Docker support for the NP-TMcode project
 
-This Dockerfile allows to create mainly:
+## Using the pre-built image
+The current version of NP-TMcode (M8.03) has been bundled in a pre-built `docker` image, distributed via `https://hub.docker.com/`. To use this image, run the command:
+
+   > docker run -it gmulas/np-tmcode-run:M8 /bin/bash
+
+The image will be automatically downloaded, if it is not available in the system, then it will be run in interactive mode, starting a shell session. Follow the instructions provided in Sec. 3.4.1 of the Release Notes document to proceed with testing and code use.
+
+## Building a local image
+A local image containing the necessary code requirements and binary files can be built through the Dockerfile provided along with the code. This Dockerfile allows to create mainly:
 
 - the np-tmcode image that is used by the gitlab pipeline runner to test compile and execution of requested merges
 - the np-tmcode-run image, that contains only the pre-built executables, python test scripts, compiled documentation, and the minimal runtime to run them

containers/singularity/README.md

 # Singularity support for the NP-TMcode project
 
-This `np-tmcode-run.def` file allows to create a np-tmcode-run image, that contains only the pre-built executables, python test scripts, compiled documentation, and the minimal runtime to run them
+## Using the pre-built image
+The current version of NP-TMcode (M8.03) has been bundled in a pre-built `singularity` image, distributed at `https://www.ict.inaf.it/gitlab/giacomo.mulas/np-tmcode-singularity/-/releases/np-tmcode-singularity-run-M8.03`. To use this image, download and unpack the pre-built image bundle, then place the `np-tmcode-run.sif` file in the `containers/singularity` folder of the NP-TMcode project.
+
+## Building a local image
+A local image containing the necessary code requirements and binary files can be built through the image definition file provided along with the code. This `np-tmcode-run.def` file allows to create a `np-tmcode-run` image, that contains only the pre-built executables, python test scripts, compiled documentation, and the minimal runtime to run them.
 
 In order for the singularity build to create the image, singularity build must be invoked from this directory as: