Commit 8bccc887 authored by Giovanni La Mura's avatar Giovanni La Mura
Browse files

Merge branch 'm8_release_docs' into 'master' 

Add M8 documentation

See merge request giacomo.mulas/np_tmcode!44
parents 01b1cad3 dac1992f

build/README.md

+2 −2
Original line number Diff line number Diff line
@@ -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

containers/docker/README.md

+0 −2
Original line number Diff line number Diff line
@@ -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

containers/singularity/README.md

+0 −2
Original line number Diff line number Diff line
@@ -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

doc/Release_Notes_M8.02.pdf

0 → 100644
+373 KiB

File added.

No diff preview for this file type.

View file

doc/src/README.md

+0 −2
Original line number Diff line number Diff line
@@ -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