@@ -27,9 +27,13 @@ This section describes the use of the pre-existing programs, once the binaries h
> ./np_cluster
*NOTE:* The C++ version does not need to run a configuration program because all configuration operations are handled by the code at run-time.
*NOTE:* The *C++* version does not need to run a configuration program because all configuration operations are handled by the code at run-time.
5. Check the consistency between the output files (the default output file for the FORTRAN code is named `OCLU`, while the corresponding C++ output has the default name of `c_OCLU`).
5. Check the consistency between the output files (the default output file for the *FORTRAN* code is named `OCLU`, while the corresponding *C++* output has the default name of `c_OCLU`).
The default behaviour of `np_cluster` is to take the same input files as `edfb` and `clu` and to write the output in the current folder. If needed, different input and output paths can be given as command-line arguments:
@@ -48,9 +52,13 @@ This section describes the use of the pre-existing programs, once the binaries h
> ./np_sphere
*NOTE:* The C++ version does not need to run a configuration program because all configuration operations are handled by the code at run-time.
*NOTE:* The *C++* version does not need to run a configuration program because all configuration operations are handled by the code at run-time.
5. Check the consistency between the output files (the default output file for the *FORTRAN* code is named `OSPH`, while the corresponding *C++* output has the default name of `c_OSPH`).
The default behaviour of `np_sphere` is to take the same input files as `edfb` and `sph` and to write the output in the current folder. If needed, different input and output paths can be given as command-line arguments:
5. Check the consistency between the output files (the default output file for the FORTRAN code is named `OSPH`, while the corresponding C++ output has the default name of `c_OSPH`).
This directory contains the material to build the project documentation with `doxygen`.
This directory contains the material to build the project documentation with *doxygen*.
## Instructions
The project documentation is managed by `doxygen`, a documentation generator that is able to extract documents directly from properly formatted comment sections of the source code. To build a local instance of project documents, make sure that you have `doxygen` installed, then `cd` into the document source folder (the folder containing the `conf.dox` file, specifically `np_tmcode/doc/src`) and finally run:
```
doxygen conf.dox
```
The project documentation is managed by *doxygen*, a documentation generator that is able to extract documents directly from properly formatted comment sections of the source code. To build a local instance of project documents, make sure that you have *doxygen* installed, then `cd` into the document source folder (the folder containing the `conf.dox` file, specifically `np_tmcode/doc/src`) and finally run:
`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`.
No newline at end of file
> doxygen conf.dox
Alternatively, you can use `make` from the project `src` folder (named `np_tmcode/src`) and just issue:
> make docs
*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`.
@@ -8,7 +8,7 @@ The original code is contained in the folders named `cluster`, `sphere` and `tra
In all cases, build commands executed through `make` will output the object files and the linked binaries in the proper folders under the build directory.
## FORTRAN code setup and execution (requires `gfortran` and GNU `make`)
## *FORTRAN* code setup and execution (requires `gfortran` and GNU `make`)
1. cd to the `src` folder.
2. Run `make` as:
@@ -16,13 +16,13 @@ In all cases, build commands executed through `make` will output the object file
> make
3. cd to the `build/sphere` folder.
4. Run `sph` following the instructions given in `build\README.md`
4. Run `sph` following the instructions given in `build/README.md`
5. cd to the `build/cluster` folder.
6. Run `clu` following the instructions given in `build\README.md`
6. Run `clu` following the instructions given in `build/README.md`
## C++ code setup and execution (requires `g++` and GNU `make`)
## *C++* code setup and execution (requires `g++` and GNU `make`)
1. Follow the FORTRAN code setup steps (this builds the C++ version too).
1. Follow the *FORTRAN* code setup steps (these build the *C++* version too).