Commit 0bca384f authored by Andrea Giannetti's avatar Andrea Giannetti
Browse files

Added .dockerignore file; updated documentation.

parent f5125041
Loading
Loading
Loading
Loading

.dockerignore

0 → 100644
+5 −0
Original line number Diff line number Diff line
/etl/stg/archive/*
/etl/prs/fits/cubes/*
/etl/prs/fits/moments/*
/etl/prs/fits/ratios/*
/etl/mdl/radmc_files/*
 No newline at end of file
+13 −2
Original line number Diff line number Diff line
@@ -45,12 +45,23 @@ The SAK non-LTE, toy model pipeline uses three main layers:
   the simulated spectra.

   The script `prs_inspect_results.py` reduces the ratio maps to single points and produces an image of the ratio values
   as a function of gas number density and temperature.
   as a function of gas number density and temperature. Be aware that at the moment the query is hardcoded and works for
   spherical models only.

The entire ETL pipeline is executed by the `main.py` script, where it is possible to define overrides for the default
values in the specific stage configuration file (so that it's possible to specify an entire grid of models). These
overrides are included into the `etl/config/config.yml` configuration file.

### Running the pipeline

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

`docker compose up`

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.

### Configuration files parameters

In this paragraph we describe in more detail the parameters that can be set in the different configuration files, and
@@ -67,7 +78,7 @@ The staging config file has two main categories:
      corresponds also to the maximum possible density in the grid.
    * density_unit: the units in which the number density is expressed, e.g. 'cm^-3'
    * density_powerlaw_idx: the power-law index of the density distribution
    * density_value_at_reference: the gas number density at a reference value, e.g. at 1 pc
    * density_at_reference: the gas number density at a reference value, e.g. at 1 pc
    * distance_reference: the reference radius for scaling the power-law
    * distance_reference_unit: the units of the reference radius, e.g. 'pc', 'AU', 'cm'
    * dust_temperature: the dust temperature value