Update Documentation authored by Doriann Blain's avatar Doriann Blain
# Code structure
```
.
├── bin <- fortran executable directory, launch CAXS from here
| └── caxs.exe <- fortran executable
├── data <- data directory
| ├── lines <- GEISA 2015-formatted lines directory
| | └── CH4 <- Rey et al. 2017 CH4 lines directory
| ├── species <- species data directory (molar mass, vibrational modes, ...)
| └── voigt.dat <- data for the construction of the Voigt profile
├── dist <- distribution directory
| └── CAXS.tar.gz <- distribution archive
├── inputs <- inputs directory
| └── input_parameters.nml <- CAXS input parameters (wavenumbers, pressure levels, ...)
├── outputs <- results directory
├── src <- source code directory
| └── fortran <- fortran source code directory
| ├── caxs.f90 <- CAXS main file, contains the global structure of the code
| ├── interface.f90 <- module to manage inputs and outputs
| ├── math.f90 <- module containing useful math functions
| ├── mpi_utils.f90 <- module containing useful MPI functions
| ├── objects.f90 <- contains object-like modules with attributes
| ├── physical_constants.f90 <- module containing useful physical constants
| └── transfer.f90 <- module containing functions used to calculate the abs.
├── CHANGELOG.md <- contains an historic of the code modifications
├── LICENSE.md <- contains the licence of the software
├── Makefile <- used to compile the code with 'make'
├── README.md <- contains useful informations about the software
└── sdist <- shell script used to make the distribution archive
```
\ No newline at end of file
**This page is a work in progress**
In order to have information on the different functions used in the code and their parameters, we you can look at the docstrings in the source code.
\ No newline at end of file