Commit 5c9cf762 authored by Andrea Giannetti's avatar Andrea Giannetti
Browse files

Reformatted text.

parent 84a56d9b
Loading
Loading
Loading
Loading
+57 −44
Original line number Diff line number Diff line
@@ -61,10 +61,12 @@ their meaning.
#### The staging configuration file (`etl/stg/config/config.yml`)

The staging config file has three main categories:

* **grid:**
    * grid_type: regular or spherical
    * coordinate_system: cartesian or polar
  * central_density: the central gas number density of the toy model. If you are using a power-law distribution, it corresponds also to the maximum possible density in the grid. 
    * central_density: the central gas number density of the toy model. If you are using a power-law distribution, it
      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
@@ -75,26 +77,34 @@ The staging config file has three main categories:
    * dust_temperature_powerlaw_idx: the dust temperature power-law index
    * microturbulence: the unresolved turbulent velocity of the gas
    * microturbulence_unit: the units of the microturbulence value, e.g. 'km/s'
  * dimN: a dictionary-like parameter, it should include the 'size', 'size_unit', 'shape', and 'refpix' keys. E.g. {"size":1, "size_units": "pc", "shape": 3, "refpix": 1}. If only dim1 is provided, the grid is cubic.
    * dimN: a dictionary-like parameter, it should include the 'size', 'size_unit', 'shape', and 'refpix' keys. E.g. {"
      size":1, "size_units": "pc", "shape": 3, "refpix": 1}. If only dim1 is provided, the grid is cubic.
        * size: the grid size in physical units
        * size_unit: the units in which the grid size is expressed, e.g. 'pc'
        * shape: the number of cells in the grid for this axis
    * refpix: the reference pixel that corresponds to the grid "centre" from which the distance are computed for power-law models, for instance
  * velocity_field: velocity field to apply to the gas, it can only be 'solid' at the moment (the gas is assumed to rotate around the y axis). Power-law is in principle also supported, but the wiring is still to be implemented.  
        * refpix: the reference pixel that corresponds to the grid "centre" from which the distance are computed for
          power-law models, for instance
    * velocity_field: velocity field to apply to the gas, it can only be 'solid' at the moment (the gas is assumed to
      rotate around the y axis). Power-law is in principle also supported, but the wiring is still to be implemented.
    * velocity_gradient: the value of the velocity gradient for solid-body roation.
    * velocity_gradient_unit: the unit of the velocity gradient, e.g. "km/s/pc"

* **lines:**
    * species_to_include: the list of molecular species to include in the RADMC postprocessing, e.g. ['e-ch3oh']
  * molecular_abundances: a dict-like parameter, containing the species name and the corresponding fractional abundance, e.g. {"e-ch3oh": 1e-8, "p-h2": 1}
  * lines_mode: the line transfer mode. It can be 'lte', 'lvg', 'optically_thin_non_lte', 'user_defined_populations' (see the RADMC documentation if in doubt)
  * collision_partners: the list of collision partners to be used; it must appear in the correct order as in the molecule_{molname}.inp file of the molecule to be simulated, e.g. ['p-h2']
    * molecular_abundances: a dict-like parameter, containing the species name and the corresponding fractional
      abundance, e.g. {"e-ch3oh": 1e-8, "p-h2": 1}
    * lines_mode: the line transfer mode. It can be 'lte', 'lvg', 'optically_thin_non_lte', 'user_defined_populations' (
      see the RADMC documentation if in doubt)
    * collision_partners: the list of collision partners to be used; it must appear in the correct order as in the
      molecule_{molname}.inp file of the molecule to be simulated, e.g. ['p-h2']

* **radmc:**
    * nphotons: the number of photons to use for the postprocessing
  * scattering_mode_max: override the scattering settings in the dust opacity files; 0 excludes scattering, 1 treats it in an isotropic way (if defined), 2 includes anisotropic scattering (if defined)
    * scattering_mode_max: override the scattering settings in the dust opacity files; 0 excludes scattering, 1 treats
      it in an isotropic way (if defined), 2 includes anisotropic scattering (if defined)
    * iranfreqmode: 1
  * tgas_eq_tdust: whether the gas temperature is equal to the dust temperature (if not, it must be specified or computed separately!)
    * tgas_eq_tdust: whether the gas temperature is equal to the dust temperature (if not, it must be specified or
      computed separately!)

#### The model configuration file (`etl/mdl/config/config.yml`)

@@ -116,9 +126,12 @@ The global configuration file has only the "overrides" category:
* **overrides:**
  dust_temperature_grid_type: the spacing in the dust temperature grid, can be: 'linear', 'log'
  dust_temperature_limits: the limits in the dust temperature grid, e.g. [10, 30]; the last point is excluded
    dust_temperature_step: the step size in the grid; if the spacing is logarithmic, it represents the increase factor, e.g. 10 means steps of one order of magnitude
  dust_temperature_step: the step size in the grid; if the spacing is logarithmic, it represents the increase factor,
  e.g. 10 means steps of one order of magnitude
  gas_density_grid_type: the spacing in the gas number density grid, can be: 'linear', 'log'
  gas_density_limits: the limits in the gas number density grid, e.g. [1e4, 1e8]; the last point is excluded
    gas_density_step: the step size in the grid; if the spacing is logarithmic, it represents the increase factor, e.g. 10 means steps of one order of magnitude
  gas_density_step: the step size in the grid; if the spacing is logarithmic, it represents the increase factor, e.g. 10
  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']
  lines_to_process: the list of line identifiers to process, according to the molecule_{molname}.inp file,
  e.g. ['87', '86']