From dac1992f513f4a8112975746e0288f5aef179682 Mon Sep 17 00:00:00 2001
From: Giovanni La Mura <giovanni.lamura@inaf.it>
Date: Mon, 24 Jun 2024 18:21:51 +0200
Subject: [PATCH] Remove double License section and provide a complete
instruction disclaimer pointing to Release Notes
---
build/README.md | 4 ++--
containers/docker/README.md | 2 --
containers/singularity/README.md | 2 --
doc/src/README.md | 2 --
src/README.md | 4 ++--
src/scripts/README.md | 2 --
test_data/README.md | 2 --
7 files changed, 4 insertions(+), 14 deletions(-)
diff --git a/build/README.md b/build/README.md
index c4b1aacd..98d87f1b 100644
--- a/build/README.md
+++ b/build/README.md
@@ -10,6 +10,8 @@ The original code produces output in the current working directory (the path whe
This section describes the use of the pre-existing programs, once the binaries have been properly built by a succesful run of `make` in the `src` folder.
+*NOTE:* This set of instructions applies to the serial code implementation only. Please, refer to the Release Notes of `NP_TMcode-M8.02` for more details on how to build and use a parallel implementation of the code.
+
### cluster
1. cd to the `build/cluster` folder.
@@ -96,8 +98,6 @@ This program checks for the consistency of transition matrix data files. It is e
where the arguments must be valid paths to binary transition matrix files saved in the legaci or the _HDF5_ format. Similarly to the previous case, the program writes a short log and returns a result value of 0, for success, or a positive number in case of inconsistency detection.
-# License
-
# License
Copyright (C) 2024 INAF - Osservatorio Astronomico di Cagliari
diff --git a/containers/docker/README.md b/containers/docker/README.md
index 271a4a58..2f06074a 100644
--- a/containers/docker/README.md
+++ b/containers/docker/README.md
@@ -11,8 +11,6 @@ In order for the docker build to correctly set the context, so that it can acces
where `<image name>` is either `np-tmcode` or `np-tmcode-run`. One may also add the docker build option `-t tagname` to specify the `tagname` the built image should have in his/her registry.
-# License
-
# License
Copyright (C) 2024 INAF - Osservatorio Astronomico di Cagliari
diff --git a/containers/singularity/README.md b/containers/singularity/README.md
index 12ab899c..49112adb 100644
--- a/containers/singularity/README.md
+++ b/containers/singularity/README.md
@@ -18,8 +18,6 @@ or directly as
where `<full path to image name>` is the name of the sif image, including full or relative path to it, and `<np-tmcode command>` is one of the executables built in np-tmcode project, or the `pycompare.py` script used to compare results between the Fortran and C++ versions of the code. These executables, as well as the minimum runtime for them to execute correctly, are embedded in the image, and "see" the current directory the image is run in (which technically is automatically bind-mounted by singularity in the running image instance).
-# License
-
# License
Copyright (C) 2024 INAF - Osservatorio Astronomico di Cagliari
diff --git a/doc/src/README.md b/doc/src/README.md
index ebcd796d..6b6a3ba7 100644
--- a/doc/src/README.md
+++ b/doc/src/README.md
@@ -14,8 +14,6 @@ Alternatively, you can use `make` from the project `src` folder (named `np_tmcod
*doxygen* will automatically build the HTML structure to cover all the documented source code and it will additionally provide the fundamental structure to prepare a LaTeX formatted version of the documents. These two outputs will be placed, respectively, under the folders `np_tmcode/doc/build/html` and `np_tmcode/doc/build/latex`.
-# License
-
# License
Copyright (C) 2024 INAF - Osservatorio Astronomico di Cagliari
diff --git a/src/README.md b/src/README.md
index 5f501604..33759fca 100644
--- a/src/README.md
+++ b/src/README.md
@@ -22,6 +22,8 @@ In all cases, build commands executed through `make` will output the object file
## *C++* code setup and execution (requires `g++` and GNU `make`)
+*NOTE:* This set of instructions is for serial code implementation only. Please, refer to the Release Notes of `NP_TMcode-M8.02` for more details on how to build and use a parallel implementation of the code.
+
1. Follow the *FORTRAN* code setup steps (these build the *C++* version too).
2. cd to the `build/sphere` folder.
3. Run `np_sphere`:
@@ -36,8 +38,6 @@ In all cases, build commands executed through `make` will output the object file
7. Check the consistency between the text files named `OCLU` and `c_OCLU`
-# License
-
# License
Copyright (C) 2024 INAF - Osservatorio Astronomico di Cagliari
diff --git a/src/scripts/README.md b/src/scripts/README.md
index e8d2b1d1..678a73f8 100644
--- a/src/scripts/README.md
+++ b/src/scripts/README.md
@@ -35,8 +35,6 @@ Performance estimates can be obtained from the code logging system, assuming the
where `LOG_FILE` must be the name of a file containing the output that would normally go to terminal, `FILTER` must be the starting character sequence of the log line identifying the operation that should be taken into account, and `NUM_THREADS` is the number of processes that were used to perform the whole calculation loop. In case no filter is given, the script provides an estimate of the total amount of time spent in doing the calculation. This estimate, however, is known not to be reliable, because it ignores thread concurrency effects. A more accurate estimate of the total time spent in executing the code is always saved in a file named `c_timing.log`.
-# License
-
# License
Copyright (C) 2024 INAF - Osservatorio Astronomico di Cagliari
diff --git a/test_data/README.md b/test_data/README.md
index 0a6fe153..64a7dbf4 100644
--- a/test_data/README.md
+++ b/test_data/README.md
@@ -60,8 +60,6 @@ were the different lines have the following roles:
4. a flag to set whether the intermediate data should be written to output files
5. an end-of-file code (generally 0)
-# License
-
# License
Copyright (C) 2024 INAF - Osservatorio Astronomico di Cagliari
--
GitLab