Commit f777e9d9 authored by Andrea Giannetti's avatar Andrea Giannetti
Browse files

Updated documentation.md.

parent 035922e8
Loading
Loading
Loading
Loading
+10 −2
Original line number Diff line number Diff line
@@ -56,12 +56,19 @@ overrides are included into the `etl/config/config.yml` configuration file.

The pipeline is now dockerized. To run it clone the repository and in bash run:

`docker compose up`
`docker compose up --build`

from the root project directory. Docker compose will bring up a local database for your runs, with a persistent storage,
so that all the results can be found and inspected. Similarly, a local volume is mounted, so that intermediate files (
radmc files, cubes, moment zero- and ratio images) can be found in the project directory structure, after a run.

To reset the database, use the command:

`docker volume rm swiss_army_knife_db`.

Be aware that at the moment the first run (also after DB reset) fails due to an issue in the DB initialization. Run the
docker compose command once more to start the pipeline.

### Configuration files parameters

In this paragraph we describe in more detail the parameters that can be set in the different configuration files, and
@@ -143,4 +150,5 @@ The global configuration file has only the "overrides" category:
  means steps of one order of magnitude
  gas_density_unit: the units in which the gas number density is expressed, e.g. 'cm^-3'
  lines_to_process: the list of line identifiers to process, according to the molecule_{molname}.inp file,
  e.g. ['87', '86']
  e.g. [['87', '86'], ['88', '87']]. The parameter is gives as a list of lists, so that the program knows which ratios
  to compute.