Update Documentation authored by Charnay Benjamin's avatar Charnay Benjamin
Summary: Summary:
- [Input file](#input-file) - [Input file](#input-file)
- [output_files](#output_files) - [output_files](#output_files)
- [target_parameters](#target_parameters) - [target_parameters](#target_parameters)
- [light_source_parameters](#light_source_parameters) - [light_source_parameters](#light_source_parameters)
- [atmosphere_parameters](#atmosphere_parameters) - [atmosphere_parameters](#atmosphere_parameters)
- [species_parameters](#species_parameters) - [species_parameters](#species_parameters)
- [spectrum_parameters](#spectrum_parameters) - [spectrum_parameters](#spectrum_parameters)
- [clouds_parameters](#clouds_parameters) - [clouds_parameters](#clouds_parameters)
- [retrieval_parameters](#retrieval_parameters) - [retrieval_parameters](#retrieval_parameters)
- [options](#options) - [options](#options)
- [paths](#paths) - [paths](#paths)
- [Output file (HDF5)](#output-file-hdf5) - [Output file (HDF5)](#output-file-hdf5)
- [Code](#code) - [Code](#code)
# Input file # Input file
The input file format is [Fortran namelist](https://software.intel.com/content/www/us/en/develop/documentation/fortran-compiler-developer-guide-and-reference/top/language-reference/a-to-z-reference/m-to-n/namelist.html). All of the headers and variables must be present. If your input file does not work, start back with a working example. An input file, _example.nml_ is provided with any distributed version of *Exo-REM*, with a short description of each variables. The input file format is [Fortran namelist](https://software.intel.com/content/www/us/en/develop/documentation/fortran-compiler-developer-guide-and-reference/top/language-reference/a-to-z-reference/m-to-n/namelist.html). All of the headers and variables must be present. If your input file does not work, start back with a working example. An input file, _example.nml_ is provided with any distributed version of *Exo-REM*, with a short description of each variables.
Comments are handled with `!`. Comments are handled with `!`.
Below is the complete list of headers and variables as well as an extended description. The units are indicated in parenthesis: Below is the complete list of headers and variables as well as an extended description. The units are indicated in parenthesis:
## output_files ## output_files
The `output_files` section allows you to personalize the names of the output files. The output directory is set with `path_outputs` (see [`paths`](#paths)). The `output_files` section allows you to personalize the names of the output files. The output directory is set with `path_outputs` (see [`paths`](#paths)).
- `spectrum_file_prefix` - `spectrum_file_prefix`
- string - string
- prefix of the spectrum files - prefix of the spectrum files
- e.g. with `spectrum_file_prefix = 'spectra'`, the spectrum file will be _spectra_XXX.dat_, where _XXX_ is the output files suffix. Has no influence if `ouput_hdf5` is `True`. - e.g. with `spectrum_file_prefix = 'spectra'`, the spectrum file will be _spectra_XXX.dat_, where _XXX_ is the output files suffix. Has no influence if `ouput_hdf5` is `True`.
- `temperature_profile_file_prefix` - units of the file: wavenumber in cm-1, flux in W.m-2/cm-1
- string - `temperature_profile_file_prefix`
- prefix of the temperature profile files - string
- e.g. with `temperature_profile_file_prefix = 'temperature_profile'`, the temperature file will be _temperature_profile_XXX.dat_, where _XXX_ is the output files suffix. Has no influence if `ouput_hdf5` is `True`. - prefix of the temperature profile files
- `vmr_file_prefix` - e.g. with `temperature_profile_file_prefix = 'temperature_profile'`, the temperature file will be _temperature_profile_XXX.dat_, where _XXX_ is the output files suffix. Has no influence if `ouput_hdf5` is `True`.
- string - units of the file: pressure in Pa, temperature in K
- prefix of the volume mixing ratio profiles files - `vmr_file_prefix`
- e.g. with `vmr_file_prefix = 'vmr'`, the vmr file will be _vmr_XXX.dat_, where _XXX_ is the output files suffix. Has no influence if `ouput_hdf5` is `True`. - string
- `output_files_suffix` - prefix of the volume mixing ratio profiles files
- string - e.g. with `vmr_file_prefix = 'vmr'`, the vmr file will be _vmr_XXX.dat_, where _XXX_ is the output files suffix. Has no influence if `ouput_hdf5` is `True`.
- suffix of the output files - units of the file: pressure in Pa, vmr in mol/mol
- e.g. with `output_files_suffix = 'example'` and `ouput_hdf5 = False`, the output files will be _YYY_example.dat_, where _YYY_ are the output files prefix. If `ouput_hdf5` is `True`, the sole output file will be _example.h5_. - `output_files_suffix`
- string
## target_parameters - suffix of the output files
The `target_parameters` section handles the target (planet) settings. - e.g. with `output_files_suffix = 'example'` and `ouput_hdf5 = False`, the output files will be _YYY_example.dat_, where _YYY_ are the output files prefix. If `ouput_hdf5` is `True`, the sole output file will be _example.h5_.
- `use_gravity`
- boolean ## target_parameters
- if True, uses equatorial gravity instead of mass to calculate gravity The `target_parameters` section handles the target (planet) settings.
- e.g. `use_gravity = False`. In that case, the equatorial gravity at 1 bar is derived from `target_equatorial_radius` and `target_mass`. If `True`, the equatorial gravity at 1 bar is derived from `target_equatorial_gravity`. - `use_gravity`
- `use_flattening` - boolean
- boolean - if True, uses equatorial gravity instead of mass to calculate gravity
- if True, uses flattening instead of polar radius to calculate gravity - e.g. `use_gravity = False`. In that case, the equatorial gravity at 1 bar is derived from `target_equatorial_radius` and `target_mass`. If `True`, the equatorial gravity at 1 bar is derived from `target_equatorial_gravity`.
- e.g. `use_flattening = True`. In that case, the gravity at 1 bar will be derived from `target_flattening`, `latitude` and the equatorial gravity. If `False`, the gravity at 1 bar will be derived from `target_polar_radius`, `target_equatorial_radius`, `latitude` and the equatorial gravity. - `use_flattening`
- `target_mass` - boolean
- float - if True, uses flattening instead of polar radius to calculate gravity
- (kg) mass of the target - e.g. `use_flattening = True`. In that case, the gravity at 1 bar will be derived from `target_flattening`, `latitude` and the equatorial gravity. If `False`, the gravity at 1 bar will be derived from `target_polar_radius`, `target_equatorial_radius`, `latitude` and the equatorial gravity.
- e.g. `target_mass = 5e25`. Used to calculate gravity, only if `use_gravity` is `False`. - `target_mass`
- `target_equatorial_gravity` - float
- float - (kg) mass of the target
- (m.s-2) gravity at 1 bar of the target - e.g. `target_mass = 5e25`. Used to calculate gravity, only if `use_gravity` is `False`.
- e.g. `target_equatorial_gravity = 14.83`. Used only if `use_gravity` is `True`. - `target_equatorial_gravity`
- `target_equatorial_radius` - float
- float - (m.s-2) gravity at 1 bar of the target
- (m) equatorial radius at 1 bar of the target - e.g. `target_equatorial_gravity = 14.83`. Used only if `use_gravity` is `True`.
- e.g. `target_equatorial_radius = 15000e3`. - `target_equatorial_radius`
- `target_polar_radius` - float
- float - (m) equatorial radius at 1 bar of the target
- (m) polar radius at 1 bar of the target - e.g. `target_equatorial_radius = 15000e3`.
- e.g. `target_polar_radius = 15000e3`. Used only if `use_flattening` is `False`. - `target_polar_radius`
- `target_flattening` - float
- float - (m) polar radius at 1 bar of the target
- flattening of the target - e.g. `target_polar_radius = 15000e3`. Used only if `use_flattening` is `False`.
- e.g. `target_flattening = 0` for a perfect sphere. Used only if `use_flattening` is `True`. - `target_flattening`
- `latitude` - float
- float - flattening of the target
- (deg) latitude of observation on the target - e.g. `target_flattening = 0` for a perfect sphere. Used only if `use_flattening` is `True`.
- e.g. `latitude = 0` to look at the equator. - `latitude`
- `target_internal_temperature` - float
- float - (deg) latitude of observation on the target
- (K) internal (or intrinsic) temperature of the target - e.g. `latitude = 0` to look at the equator.
- e.g. `target_internal_temperature = 500`. This is the temperature derived from the radiosity (upward flux) of the target (i.e. the radiosity corresponds to that of a black body at `target_internal_temperature`) if it was perfectly isolated (i.e. without any external light source/star). *Exo-REM* will change the temperature profile so that the calculated internal temperature is as close as possible to `target_internal_temperature`. - `target_internal_temperature`
- `emission_angle` [unused parameter] - float
- float - (K) internal (or intrinsic) temperature of the target
- (deg) emission angle - e.g. `target_internal_temperature = 500`. This is the temperature derived from the radiosity (upward flux) of the target (i.e. the radiosity corresponds to that of a black body at `target_internal_temperature`) if it was perfectly isolated (i.e. without any external light source/star). *Exo-REM* will change the temperature profile so that the calculated internal temperature is as close as possible to `target_internal_temperature`.
- e.g. `emission_angle = 0.0` to look along the normal of the atmosphere. Could be used in the calculation of the emission spectrum. - `emission_angle` [unused parameter]
- float
## light_source_parameters - (deg) emission angle
The `light_source_parameters` section handles the light source (star) settings. - e.g. `emission_angle = 0.0` to look along the normal of the atmosphere. Could be used in the calculation of the emission spectrum.
- `add_light_source`
- boolean ## light_source_parameters
- if True, add the light source The `light_source_parameters` section handles the light source (star) settings.
- e.g. `add_light_source = True`. In that case, a light source/star will be added, and the atmosphere will be irradiated. If `False`, the other parameters in this section are not taken into. - `add_light_source`
- `use_irradiation` - boolean
- boolean - if True, add the light source
- if True, use irradiation instead of range to calculate the light source spectrum - e.g. `add_light_source = True`. In that case, a light source/star will be added, and the atmosphere will be irradiated. If `False`, the other parameters in this section are not taken into.
- e.g. `use_irradiation = False`. In that case, the irradiation will be calculated using `light_source_range`. If `True`, the distance between the light source and the target will be calculated from `light_source_irradiation`. - `use_irradiation`
- `use_light_source_spectrum` - boolean
- boolean - if True, use irradiation instead of range to calculate the light source spectrum
- if True, use a spectrum for the light source instead of a black body - e.g. `use_irradiation = False`. In that case, the irradiation will be calculated using `light_source_range`. If `True`, the distance between the light source and the target will be calculated from `light_source_irradiation`.
- e.g. `use_light_source_spectrum = False`. In that case, the spectral irradiance of the target will be calculated from a black body. If `True`, the spectral irradiance is read from `light_source_spectrum_file` and re-adapted so that the light source radiosity correspond to `light_source_effective_temperature`. - `use_light_source_spectrum`
- `light_source_radius` - boolean
- float - if True, use a spectrum for the light source instead of a black body
- (m) radius of the light source - e.g. `use_light_source_spectrum = False`. In that case, the spectral irradiance of the target will be calculated from a black body. If `True`, the spectral irradiance is read from `light_source_spectrum_file` and re-adapted so that the light source radiosity correspond to `light_source_effective_temperature`.
- e.g. `light_source_radius = 100e6`. - `light_source_radius`
- `light_source_range` - float
- float - (m) radius of the light source
- (m) distance between the target and the light source - e.g. `light_source_radius = 100e6`.
- e.g. `light_source_range = 2e9`. Used to calculate the target/planet irradiance if `use_irradiation` is `False`. - `light_source_range`
- `light_source_effective_temperature` - float
- float - (m) distance between the target and the light source
- (K) light source effective temperature - e.g. `light_source_range = 2e9`. Used to calculate the target/planet irradiance if `use_irradiation` is `False`.
- e.g. `light_source_effective_temperature = 3450`. - `light_source_effective_temperature`
- `light_source_irradiation` - float
- float - (K) light source effective temperature
- (W.m-2) light source irradiation - e.g. `light_source_effective_temperature = 3450`.
- e.g. `light_source_irradiation = 20000`. Used to calculate the target/planet irradiance if `use_irradiation` is `True`. - `light_source_irradiation`
- `light_source_spectrum_file` - float
- string - (W.m-2) light source irradiation
- spectrum of the light source - e.g. `light_source_irradiation = 20000`. Used to calculate the target/planet irradiance if `use_irradiation` is `True`.
- e.g. with `light_source_spectrum_file = 'spectrum_BTSettl_3500K_logg5_met0.dat'`. The file must be placed in the `path_light_source_spectra` directory. Used only if `use_light_source_spectrum` is `True`. - `light_source_spectrum_file`
- `incidence_angle` [unused parameter] - string
- float - spectrum of the light source
- (deg) incident light source light relative to the normal of the atmosphere - e.g. with `light_source_spectrum_file = 'spectrum_BTSettl_3500K_logg5_met0.dat'`. The file must be placed in the `path_light_source_spectra` directory. Used only if `use_light_source_spectrum` is `True`.
- e.g. `incidence_angle = 0.0` if the light rays are have the same direction than the normal of the atmosphere. Could be used to calculate the temperature profile at a specific local hour on the target/planet. - units of the file for BT-Settl: wavelength in angstrom, flux in erg.s-1.cm-2.a-1
- `incidence_angle` [unused parameter]
## atmosphere_parameters - float
The `atmosphere_parameters` section handles the atmospheric settings. - (deg) incident light source light relative to the normal of the atmosphere
- `use_metallicity` - e.g. `incidence_angle = 0.0` if the light rays are have the same direction than the normal of the atmosphere. Could be used to calculate the temperature profile at a specific local hour on the target/planet.
- boolean
- if True, uses metallicity instead of H2, He and Z VMR to get the elemental abundances ## atmosphere_parameters
- e.g. `use_metallicity = True`. In that case, the elemental abundances are calculated from `metallicity`. If `False`, they are calculated from `h2_vmr`, `he_vmr` and `z_vmr`. The `atmosphere_parameters` section handles the atmospheric settings.
- `use_pressure_grid` - `use_metallicity`
- boolean - boolean
- if True, uses the pressure grid in the temperature profile file to generate the pressure grid - if True, uses metallicity instead of H2, He and Z VMR to get the elemental abundances
- e.g. `use_pressure_grid = False`. In that case, the pressure grid will be equally spaced in the log-space between `pressure_min` and `pressure_max`. If `True`, it will be directly read from `temperature_profile_file` (see [`retrieval_parameters`](#retrieval_parameters)). - e.g. `use_metallicity = True`. In that case, the elemental abundances are calculated from `metallicity`. If `False`, they are calculated from `h2_vmr`, `he_vmr` and `z_vmr`.
- `h2_vmr` - `use_pressure_grid`
- float - boolean
- H2 volume mixing ratio - if True, uses the pressure grid in the temperature profile file to generate the pressure grid
- e.g. `h2_vmr = 0.6`. `h2_vmr`, `he_vmr` and `z_vmr` will be automatically adjusted so that their sum is 1. - e.g. `use_pressure_grid = False`. In that case, the pressure grid will be equally spaced in the log-space between `pressure_min` and `pressure_max`. If `True`, it will be directly read from `temperature_profile_file` (see [`retrieval_parameters`](#retrieval_parameters)).
- `he_vmr` - `h2_vmr`
- float - float
- He volume mixing ratio - H2 volume mixing ratio
- e.g. `he_vmr = 0.1`. `h2_vmr`, `he_vmr` and `z_vmr` will be automatically adjusted so that their sum is 1. - e.g. `h2_vmr = 0.6`. `h2_vmr`, `he_vmr` and `z_vmr` will be automatically adjusted so that their sum is 1.
- `z_vmr` - `he_vmr`
- float - float
- other species volume mixing ratio - He volume mixing ratio
- e.g. `z_vmr = 0.3`. `h2_vmr`, `he_vmr` and `z_vmr` will be automatically adjusted so that their sum is 1. The heavy elements abundances are scaled from the solar abundance. - e.g. `he_vmr = 0.1`. `h2_vmr`, `he_vmr` and `z_vmr` will be automatically adjusted so that their sum is 1.
- `metallicity` - `z_vmr`
- float - float
- (solar metallicity) atmospheric metallicity - other species volume mixing ratio
- e.g. `metallicity = 10.0`. The metallicity is a factor by which all the elemental abundances except H are multiplied compared to their solar abundances. The solar abundances are read in the _data/solar_abundances.dat_ file. - e.g. `z_vmr = 0.3`. `h2_vmr`, `he_vmr` and `z_vmr` will be automatically adjusted so that their sum is 1. The heavy elements abundances are scaled from the solar abundance.
- `n_levels` - `metallicity`
- integer - float
- number of atmospheric levels - (times solar metallicity) atmospheric metallicity
- e.g. `n_levels = 81`. If `use_pressure_grid` is `False`, the bottom level has the pressure `pressure_max`, and the top level has the pressure `pressure_min`. `retrieval_level_top` must be lower or equal to this parameter. - e.g. `metallicity = 10.0`. The metallicity is a factor by which all the elemental abundances except H are multiplied compared to their solar abundances. The solar abundances are read in the _data/solar_abundances.dat_ file.
- `n_species` - `n_levels`
- integer - integer
- number of absorbing species - number of atmospheric levels
- e.g. `n_species = 13`. This parameter must match the number of elements in `species_names` and `species_at_equilibrium` (see [`species_parameters`](#species_parameters)). - e.g. `n_levels = 81`. If `use_pressure_grid` is `False`, the bottom level has the pressure `pressure_max`, and the top level has the pressure `pressure_min`. `retrieval_level_top` must be lower or equal to this parameter.
- `n_cia` - `n_species`
- integer - integer
- number of collision induced absorptions - number of absorbing species
- e.g. `n_cia = 3`. This parameter must match the number of elements in `cia_names` (see [`species_parameters`](#species_parameters)). - e.g. `n_species = 13`. This parameter must match the number of elements in `species_names` and `species_at_equilibrium` (see [`species_parameters`](#species_parameters)).
- `n_clouds` - `n_cia`
- integer - integer
- number of clouds in atmosphere - number of collision induced absorptions
- e.g. `n_clouds = 2`. This parameter must match the number of elements in `cloud_names`, `cloud_particle_radius`, `sedimentation_parameter`, `cloud_particle_density`, `cloud_molar_mass` and `reference_wavenumber` (see [`clouds_parameters`](#clouds_parameters)). - e.g. `n_cia = 3`. This parameter must match the number of elements in `cia_names` (see [`species_parameters`](#species_parameters)).
- `eddy_mode` - `n_clouds`
- string - integer
- eddy diffusion coefficient (Kzz) mode ('constant'|'Ackerman'|'AckermanConvective'|'infinity') - number of clouds in atmosphere
- e.g. `eddy_mode = 'AckermanConvective'`. `'constant'` mean that the Kzz is constant within the pressure grid, set to the value of `eddy_diffusion_coefficient`. `'Ackerman'` mean that Kzz is calculated using the method from Ackerman et al. `'AckermanConvective'` mean that Kzz is calculated using the method from Ackerman et al, but taking into account the convective flux. `'infinity'` is the same than AckermanConvective, but if `cloud_mode = 'fixedRadius'` (see [`clouds_parameters`](#clouds_parameters)), the cloud will extend to the top of the atmosphere (no sedimentation). - e.g. `n_clouds = 2`. This parameter must match the number of elements in `cloud_names`, `cloud_particle_radius`, `sedimentation_parameter`, `cloud_particle_density`, `cloud_molar_mass` and `reference_wavenumber` (see [`clouds_parameters`](#clouds_parameters)).
- `eddy_diffusion_coefficient` - `eddy_mode`
- float - string
- (cm2.s-1) eddy diffusion coefficient - eddy diffusion coefficient (Kzz) mode ('constant'|'Ackerman'|'AckermanConvective'|'infinity')
- e.g. `eddy_diffusion_coefficient = 1e8`. Used if `eddy_mode = 'constant'`. - e.g. `eddy_mode = 'AckermanConvective'`. `'constant'` mean that the Kzz is constant within the pressure grid, set to the value of `eddy_diffusion_coefficient`. `'Ackerman'` mean that Kzz is calculated using the method from Ackerman et al. `'AckermanConvective'` mean that Kzz is calculated using the method from Ackerman et al, but taking into account the convective flux. `'infinity'` is the same than AckermanConvective, but if `cloud_mode = 'fixedRadius'` (see [`clouds_parameters`](#clouds_parameters)), the cloud will extend to the top of the atmosphere (no sedimentation).
- `pressure_min` - `eddy_diffusion_coefficient`
- float - float
- (Pa) pressure at the top of the atmospheric grid - (cm2.s-1) eddy diffusion coefficient
- e.g. `pressure_min = 1e-1`. Used only if `use_pressure_grid` is `False`. - e.g. `eddy_diffusion_coefficient = 1e8`. Used if `eddy_mode = 'constant'`.
- `pressure_max` - `pressure_min`
- float - float
- (Pa) pressure at the bottom of the atmospheric grid - (Pa) pressure at the top of the atmospheric grid
- e.g. `pressure_min = 1e7`. Used only if `use_pressure_grid` is `False`. - e.g. `pressure_min = 1e-1`. Used only if `use_pressure_grid` is `False`.
- `pressure_max`
## species_parameters - float
The `species_parameters` section handles the atmospheric elemental abundances, which absorbing species to include and the chemical mode (equilibrium or out-of-equilibrium). - (Pa) pressure at the bottom of the atmospheric grid
- `use_atmospheric_metallicity` - e.g. `pressure_min = 1e7`. Used only if `use_pressure_grid` is `False`.
- boolean
- if True, use the atmospheric metallicity instead of the element/H ratios or the elements metallicity to get the elemental abundances ## species_parameters
- e.g. `use_atmospheric_metallicity = False`. In that case, the elemental abundances are calculated from `elements_h_ratio` if `use_elements_metallicity` is `False`, or else from `elements_metallicity`. If `True`, the elemental abundances are calculated only from `metallicity` (see [`atmosphere_parameters`](#atmosphere_parameters)). The `species_parameters` section handles the atmospheric elemental abundances, which absorbing species to include and the chemical mode (equilibrium or out-of-equilibrium).
- Example: - `use_atmospheric_metallicity`
- `use_atmospheric_metallicity = True`, `metallicity = 10`: He/H, C/H, O/H, N/H ... are set to 10 times their solar value. - boolean
- `use_atmospheric_metallicity = False`, `metallicity = 10`, `use_elements_metallicity = False`, `elements_names = 'He', 'C'`, `elements_h_ratio = 8e-2, 1e-30`: He/H = 8e-2, C/H = 1e-30. O/H, N/H, ... are set to 10 times their solar value. - if True, use the atmospheric metallicity instead of the element/H ratios or the elements metallicity to get the elemental abundances
- `use_atmospheric_metallicity = False`, `metallicity = 10`, `use_elements_metallicity = True`, `elements_names = 'He', 'C'`, `elements_metallicity = 1, 5`: He/H is set to 1 times its solar value. C/H is set to 5 times its solar value. O/H, N/H, ... are set to 10 times their solar value. - e.g. `use_atmospheric_metallicity = False`. In that case, the elemental abundances are calculated from `elements_h_ratio` if `use_elements_metallicity` is `False`, or else from `elements_metallicity`. If `True`, the elemental abundances are calculated only from `metallicity` (see [`atmosphere_parameters`](#atmosphere_parameters)).
- `use_elements_metallicity` - Example:
- boolean - `use_atmospheric_metallicity = True`, `metallicity = 10`: He/H, C/H, O/H, N/H ... are set to 10 times their solar value.
- if True, use the atmospheric metallicity instead of the element/H ratios or the elements metallicity to get the elemental abundances - `use_atmospheric_metallicity = False`, `metallicity = 10`, `use_elements_metallicity = False`, `elements_names = 'He', 'C'`, `elements_h_ratio = 8e-2, 1e-30`: He/H = 8e-2, C/H = 1e-30. O/H, N/H, ... are set to 10 times their solar value.
- e.g. `use_atmospheric_metallicity = False`. In that case, the elemental abundances are calculated from `elements_h_ratio` if `use_elements_metallicity` is `False`, or else from `elements_metallicity`. If `True`, the elemental abundances are calculated only from `metallicity` (see [`atmosphere_parameters`](#atmosphere_parameters)). - `use_atmospheric_metallicity = False`, `metallicity = 10`, `use_elements_metallicity = True`, `elements_names = 'He', 'C'`, `elements_metallicity = 1, 5`: He/H is set to 1 times its solar value. C/H is set to 5 times its solar value. O/H, N/H, ... are set to 10 times their solar value.
- `elements_names` - `use_elements_metallicity`
- list of strings - boolean
- elements listed here won't have the atmospheric metallicity if use_atmospheric_metallicity is False (atmosphere_parameters/metallicity) - if True, use the atmospheric metallicity instead of the element/H ratios or the elements metallicity to get the elemental abundances
- e.g. `elements_names = 'He', 'Ne', 'Ar', 'Kr', 'Xe'` to set the elemental abundances of the noble gases at a different value than `metallicity`. - e.g. `use_atmospheric_metallicity = False`. In that case, the elemental abundances are calculated from `elements_h_ratio` if `use_elements_metallicity` is `False`, or else from `elements_metallicity`. If `True`, the elemental abundances are calculated only from `metallicity` (see [`atmosphere_parameters`](#atmosphere_parameters)).
- `elements_h_ratio` - `elements_names`
- list of floats - list of strings
- element over hydrogen ratio of the elements listed above (only used if both use_atmospheric_metallicity and use_elements_metallicity are False) - elements listed here won't have the atmospheric metallicity if use_atmospheric_metallicity is False (atmosphere_parameters/metallicity)
- e.g. `elements_h_ratio = 8.395e-2, 1e-30, 1e-30, 1e-30, 1e-30`, in combination with the example above for `elements_names`, `use_elements_metallicity = False`, `use_atmospheric_metallicity = False`, to set He/H = 8.395e-2, Ne/H = 1e-30, ... - e.g. `elements_names = 'He', 'Ne', 'Ar', 'Kr', 'Xe'` to set the elemental abundances of the noble gases at a different value than `metallicity`.
- `elements_metallicity` - `elements_h_ratio`
- list of floats - list of floats
- (solar metallicity) elemental metallicity of the elements listed above - element over hydrogen ratio of the elements listed above (only used if both use_atmospheric_metallicity and use_elements_metallicity are False)
- e.g. `elements_metallicity = 1, 1, 1, 1, 1`, in combination with the example above for `elements_names`, `use_elements_metallicity = True`, `use_atmospheric_metallicity = False`, to set elemental abundances of the noble gases to 1 time their solar value. - e.g. `elements_h_ratio = 8.395e-2, 1e-30, 1e-30, 1e-30, 1e-30`, in combination with the example above for `elements_names`, `use_elements_metallicity = False`, `use_atmospheric_metallicity = False`, to set He/H = 8.395e-2, Ne/H = 1e-30, ...
- `species_names` - `elements_metallicity`
- list of strings - list of floats
- absorbing species in atmosphere - (solar metallicity) elemental metallicity of the elements listed above
- e.g. `species_names = 'CH4', 'CO', 'CO2', 'FeH', 'H2O', 'H2S', 'HCN', 'K', 'Na', 'NH3', 'PH3', 'TiO', 'VO'`. The number of elements must match `n_species` (see [`atmosphere_parameters`](#atmosphere_parameters)). The k-coefficients of these species must be within the `path_k_coefficients` directory (see [`paths`](#paths)). - e.g. `elements_metallicity = 1, 1, 1, 1, 1`, in combination with the example above for `elements_names`, `use_elements_metallicity = True`, `use_atmospheric_metallicity = False`, to set elemental abundances of the noble gases to 1 time their solar value.
- `species_at_equilibrium` - `species_names`
- list of booleans - list of strings
- if True, the species is at thermochemical equilibrium, else it is out of equilibrium - absorbing species in atmosphere
- e.g. `species_at_equilibrium = False, False, False, False, False, False, False, False, False, False, False, False, False` To set all the absorbing species in out-of-equilibrium mode. The number of elements must match `n_species` (see [`atmosphere_parameters`](#atmosphere_parameters)). - e.g. `species_names = 'CH4', 'CO', 'CO2', 'FeH', 'H2O', 'H2S', 'HCN', 'K', 'Na', 'NH3', 'PH3', 'TiO', 'VO'`. The number of elements must match `n_species` (see [`atmosphere_parameters`](#atmosphere_parameters)). The k-coefficients of these species must be within the `path_k_coefficients` directory (see [`paths`](#paths)).
- `cia_names` - `species_at_equilibrium`
- list of strings - list of booleans
- collision induced absorptions to be included - if True, the species is at thermochemical equilibrium, else it is out of equilibrium
- e.g. `cia_names = 'H2-H2', 'H2-He', 'H2O-H2O'`. The number of elements must match `n_cia` (see [`atmosphere_parameters`](#atmosphere_parameters)). The CIA files must be within the `path_cia` directory (see [`paths`](#paths)). - e.g. `species_at_equilibrium = False, False, False, False, False, False, False, False, False, False, False, False, False` To set all the absorbing species in out-of-equilibrium mode. The number of elements must match `n_species` (see [`atmosphere_parameters`](#atmosphere_parameters)).
- `load_vmr_profiles` - `cia_names`
- boolean - list of strings
- if True, load VMR profiles from a file (can be useful only if chemistry is deactivated) - collision induced absorptions to be included
- e.g. `load_vmr_profiles = False`. In that case, the VMR are initialized by *Exo-REM*. If `True`, the VMR are read from `vmr_profiles_file`. This has no impact if `n_iterations` (see [`retrieval_parameters`](#retrieval_parameters)) is greater than 0. - e.g. `cia_names = 'H2-H2', 'H2-He', 'H2O-H2O'`. The number of elements must match `n_cia` (see [`atmosphere_parameters`](#atmosphere_parameters)). The CIA files must be within the `path_cia` directory (see [`paths`](#paths)).
- `vmr_profiles_file` - `load_vmr_profiles`
- string - boolean
- VMR profiles file, ignored if load_vmr_profiles is False - if True, load VMR profiles from a file (can be useful only if chemistry is deactivated)
- e.g. `vmr_profiles_file = 'vmr_example_ref.dat'`. The file must be in the `path_vmr_profiles` directory. - e.g. `load_vmr_profiles = False`. In that case, the VMR are initialized by *Exo-REM*. If `True`, the VMR are read from `vmr_profiles_file`. This has no impact if `n_iterations` (see [`retrieval_parameters`](#retrieval_parameters)) is greater than 0.
- `vmr_profiles_file`
## spectrum_parameters - string
The `spectrum_parameters` section handles the spectral range and resolution of the calculated spectrum. - VMR profiles file, ignored if load_vmr_profiles is False
- `wavenumber_min` - e.g. `vmr_profiles_file = 'vmr_example_ref.dat'`. The file must be in the `path_vmr_profiles` directory.
- float - units: pressure in Pa, vmr in mol/mol
- (cm-1) first wavenumber of the calculated spectrum
- e.g. `wavenumber_min = 130`. ## spectrum_parameters
- `wavenumber_max` The `spectrum_parameters` section handles the spectral range and resolution of the calculated spectrum.
- float - `wavenumber_min`
- (cm-1) last wavenumber of the calculated spectrum - float
- e.g. `wavenumber_min = 30130`. - (cm-1) first wavenumber of the calculated spectrum
- `wavenumber_step` - e.g. `wavenumber_min = 130`.
- float - `wavenumber_max`
- (cm-1) wavenumber step of the calculated spectrum - float
- e.g. `wavenumber_min = 200`. - (cm-1) last wavenumber of the calculated spectrum
- e.g. `wavenumber_min = 30130`.
## clouds_parameters - `wavenumber_step`
The `clouds_parameters` section handles the clouds settings. The cloud optical constants must be within the `path_clouds` directory (see [`paths`](#paths)). - float
- `cloud_mode` - (cm-1) wavenumber step of the calculated spectrum
- string - e.g. `wavenumber_min = 200`.
- cloud mode ('fixedRadius'|'fixedSedimentation'|'fixedRadiusCondensation'|'fixedRadiusTime')
- e.g. `eddy_mode = 'fixedSedimentation'`. `'fixedRadius'` mean that the mean cloud particle radius is constant within the pressure grid, set to the value of `cloud_particle_radius`. `'fixedSedimentation'` mean that mean cloud particle is calculated based on the value of `sedimentation_parameter` (see [Ackerman and Marley 2001](https://iopscience.iop.org/article/10.1086/321540/fulltext/52911.text.html)). `'fixedRadiusCondensation'` is the same than `'fixedSedimentation'`, but the sedimentation radius is set constant two layers above the cloud condensation level. `'fixedRadiusTime'` mean that the mean cloud particle radius is calculated from the condensation timescale. ## clouds_parameters
- `cloud_fraction` The `clouds_parameters` section handles the clouds settings. The cloud optical constants must be within the `path_clouds` directory (see [`paths`](#paths)).
- float - `cloud_mode`
- cloud cover fraction - string
- e.g. `cloud_fraction = 0.15` mean that 15% of the atmosphere is covered by clouds. The flux with clouds is calculated as `(1 - cloud_fraction) * flux_clear + cloud_fraction * flux_full_cover`. - cloud mode ('fixedRadius'|'fixedSedimentation'|'fixedRadiusCondensation'|'fixedRadiusTime')
- `cloud_names` - e.g. `eddy_mode = 'fixedSedimentation'`. `'fixedRadius'` mean that the mean cloud particle radius is constant within the pressure grid, set to the value of `cloud_particle_radius`. `'fixedSedimentation'` mean that mean cloud particle is calculated based on the value of `sedimentation_parameter` (see [Ackerman and Marley 2001](https://iopscience.iop.org/article/10.1086/321540/fulltext/52911.text.html)). `'fixedRadiusCondensation'` is the same than `'fixedSedimentation'`, but the sedimentation radius is set constant two layers above the cloud condensation level. `'fixedRadiusTime'` mean that the mean cloud particle radius is calculated from the condensation timescale.
- list of strings - `cloud_fraction`
- condensing species forming the clouds - float
- e.g. `cloud_names = 'H2O', 'KCl'`. The number of elements must match `n_clouds` (see [`atmosphere_parameters`](#atmosphere_parameters)). - cloud cover fraction (dimensionless)
- `cloud_particle_radius` - e.g. `cloud_fraction = 0.15` mean that 15% of the atmosphere is covered by clouds. The flux with clouds is calculated as `(1 - cloud_fraction) * flux_clear + cloud_fraction * flux_full_cover`.
- list of floats - `cloud_names`
- (m) mean radius of the cloud particles (fixed radius modes) - list of strings
- e.g. `cloud_particle_radius = 50e-6, 5e-6`. Used only with `cloud_mode = 'fixedRadius'`. The number of elements must match `n_clouds` (see [`atmosphere_parameters`](#atmosphere_parameters)). - condensing species forming the clouds
- `sedimentation_parameter` - e.g. `cloud_names = 'H2O', 'KCl'`. The number of elements must match `n_clouds` (see [`atmosphere_parameters`](#atmosphere_parameters)).
- list of floats - `cloud_particle_radius`
- sedimentation parameter of the clouds - list of floats
- e.g. `sedimentation_parameter = 2, 2`. Used only in the `'fixedSedimentation'` and `'fixedRadiusCondensation'` modes. The number of elements must match `n_clouds` (see [`atmosphere_parameters`](#atmosphere_parameters)). - (m) mean radius of the cloud particles (fixed radius modes)
- `cloud_particle_density` - e.g. `cloud_particle_radius = 50e-6, 5e-6`. Used only with `cloud_mode = 'fixedRadius'`. The number of elements must match `n_clouds` (see [`atmosphere_parameters`](#atmosphere_parameters)).
- list of floats - `sedimentation_parameter`
- (kg.m-3) density of the clouds particles - list of floats
- e.g. `cloud_particle_density = 917, 1980`. The number of elements must match `n_clouds` (see [`atmosphere_parameters`](#atmosphere_parameters)). - sedimentation parameter (dimensionless) of the clouds
- `supersaturation_parameter` - e.g. `sedimentation_parameter = 2, 2`. Used only in the `'fixedSedimentation'` and `'fixedRadiusCondensation'` modes. The number of elements must match `n_clouds` (see [`atmosphere_parameters`](#atmosphere_parameters)).
- list of floats - `cloud_particle_density`
- supersaturation parameter of the clouds - list of floats
- e.g. `supersaturation_parameter = 0.003, 0.003`. - (kg.m-3) density of the clouds particles
- `sticking_efficiency` - e.g. `cloud_particle_density = 917, 1980`. The number of elements must match `n_clouds` (see [`atmosphere_parameters`](#atmosphere_parameters)).
- list of floats - `supersaturation_parameter`
- sticking efficiency of the clouds - list of floats
- e.g. `sticking_efficiency = 1.0, 1.0`. - supersaturation parameter of the clouds
- `reference_wavenumber` - e.g. `supersaturation_parameter = 0.003, 0.003`.
- list of floats - `sticking_efficiency`
- (cm-1) [for diagnostic] wavenumber for cloud optical depth output - list of floats
- e.g. `reference_wavenumber = 1e4, 1e4`. Output the cloud opacities at this wavenumber. The number of elements must match `n_clouds` (see [`atmosphere_parameters`](#atmosphere_parameters)). - sticking efficiency (dimensionless) of the clouds
- `load_cloud_profiles` - e.g. `sticking_efficiency = 1.0, 1.0`.
- boolean - `reference_wavenumber`
- if True, use initial cloud profile defined in vmr_profiles_file - list of floats
- e.g. `load_cloud_profiles = False`. - (cm-1) [for diagnostic] wavenumber for cloud optical depth output
- e.g. `reference_wavenumber = 1e4, 1e4`. Output the cloud opacities at this wavenumber. The number of elements must match `n_clouds` (see [`atmosphere_parameters`](#atmosphere_parameters)).
## retrieval_parameters - `load_cloud_profiles`
The `retrieval_parameters` section handles the retrieval/inversion settings. - boolean
- `temperature_profile_file` - if True, use initial cloud profile defined in vmr_profiles_file
- string - e.g. `load_cloud_profiles = False`.
- a-priori temperature profile file
- e.g. `temperature_profile_file = 'temperature_profile_example_ref.dat' `. The file must be in the `path_temperature_profile` directory. ## retrieval_parameters
- `retrieval_level_bottom` The `retrieval_parameters` section handles the retrieval/inversion settings.
- integer - `temperature_profile_file`
- min level for flux retrieval - string
- e.g. `retrieval_level_bottom = 2` mean that the retrieval will not take into account levels below the 2nd one. A value greater than 1 is strongly recommended. - a-priori temperature profile file
- `retrieval_level_top` - e.g. `temperature_profile_file = 'temperature_profile_example_ref.dat' `. The file must be in the `path_temperature_profile` directory.
- integer - units: pressure in Pa, temperature in K
- max level for flux retrieval - `retrieval_level_bottom`
- e.g. `retrieval_level_top = 81` mean that the retrieval will not take into account levels above the 81st one. This value must be between `retrieval_level_bottom` and `n_levels`. - integer
- `retrieval_flux_error_bottom` - min level for flux retrieval
- float - e.g. `retrieval_level_bottom = 2` mean that the retrieval will not take into account levels below the 2nd one. A value greater than 1 is strongly recommended.
- relative flux error at the bottom of the atmospheric grid - `retrieval_level_top`
- e.g. `retrieval_flux_error_bottom = 1e-3`. This represents the tolerance of the retrieval at the bottom of the atmosphere. A value between `1e-2` and `1e-15` is recommended. - integer
- `retrieval_flux_error_top` - max level for flux retrieval
- float - e.g. `retrieval_level_top = 81` mean that the retrieval will not take into account levels above the 81st one. This value must be between `retrieval_level_bottom` and `n_levels`.
- relative flux error at the top of the atmospheric grid - `retrieval_flux_error_bottom`
- e.g. `retrieval_flux_error_top = 1e-5`. This represents the tolerance of the retrieval at the top of the atmosphere. A value between `1e-2` and `1e-15` is recommended. - float
- `n_iterations` - relative flux error (dimensionless) at the bottom of the atmospheric grid
- integer - e.g. `retrieval_flux_error_bottom = 1e-3`. This represents the tolerance of the retrieval at the bottom of the atmosphere. A value between `1e-2` and `1e-15` is recommended.
- number of iterations - `retrieval_flux_error_top`
- e.g. `n_iterations = 30`. Maximum number of iterations allowed. - float
- `n_non_adiabatic_iterations` - relative flux error (dimensionless) at the top of the atmospheric grid
- integer - e.g. `retrieval_flux_error_top = 1e-5`. This represents the tolerance of the retrieval at the top of the atmosphere. A value between `1e-2` and `1e-15` is recommended.
- number of iterations without including the adiabatic correction (necessary for convergence) - `n_iterations`
- e.g. `n_non_adiabatic_iterations = 15`. Maximum number of iterations without requiring an adiabatic temperature profile allowed. It is recommended to set this parameter `> 1` when far from convergence. It must be below `n_iterations`. - integer
- `chemistry_iteration_interval` - number of iterations
- integer - e.g. `n_iterations = 30`. Maximum number of iterations allowed.
- number of iterations between 2 calls the of the thermochemical equilibrium - `n_non_adiabatic_iterations`
- e.g. `chemistry_iteration_interval = 2` mean that the chemistry is calculated with an interval of 2 iterations, i.e. every 3 iterations. - integer
- `cloud_iteration_interval` - number of iterations without including the adiabatic correction (necessary for convergence)
- integer - e.g. `n_non_adiabatic_iterations = 15`. Maximum number of iterations without requiring an adiabatic temperature profile allowed. It is recommended to set this parameter `> 1` when far from convergence. It must be below `n_iterations`.
- number of iterations between 2 calls of the cloud physics - `chemistry_iteration_interval`
- e.g. `cloud_iteration_interval = 4` mean that the cloud VMR is calculated with an interval of 4 iterations, i.e. every 5 iterations. - integer
- `n_burn_iterations` - number of iterations between 2 calls the of the thermochemical equilibrium
- integer - e.g. `chemistry_iteration_interval = 2` mean that the chemistry is calculated with an interval of 2 iterations, i.e. every 3 iterations.
- number of iterations before the end where all the physics is calculated at every iterations - `cloud_iteration_interval`
- e.g. `n_burn_iterations = 99`. - integer
- `retrieval_tolerance` - number of iterations between 2 calls of the cloud physics
- float - e.g. `cloud_iteration_interval = 4` mean that the cloud VMR is calculated with an interval of 4 iterations, i.e. every 5 iterations.
- tolerance for the flux convergence (0 to use the iterations limits) - `n_burn_iterations`
- e.g. `retrieval_tolerance = 0.001` mean that if at iteration `i` the chi2 variation or the T/dT ratio is lower than 0.001, if `i < n_non_adiabatic_iterations`, the non-adiabatic runs end, else if `i > n_non_adiabatic_iterations`, the run end. A value of 0 for this parameter is recommended when far from convergence. - integer
- `smoothing_bottom` - number of iterations before the end where all the physics is calculated at every iterations
- float - e.g. `n_burn_iterations = 99`.
- (height scale) vertical profile smoothing at the bottom of the atmosphere - `retrieval_tolerance`
- e.g. `smoothing_bottom = 0.5`. - float
- `smoothing_top` - tolerance for the flux convergence (0 to use the iterations limits)
- float - e.g. `retrieval_tolerance = 0.001` mean that if at iteration `i` the chi2 variation or the T/dT ratio is lower than 0.001, if `i < n_non_adiabatic_iterations`, the non-adiabatic runs end, else if `i > n_non_adiabatic_iterations`, the run end. A value of 0 for this parameter is recommended when far from convergence.
- (height scale) vertical profile smoothing at the top of the atmosphere - `smoothing_bottom`
- e.g. `smoothing_top = 0.5`. - float
- `weight_apriori` - (height scale) vertical profile smoothing at the bottom of the atmosphere
- float - e.g. `smoothing_bottom = 0.5`.
- weight of the a priori, low weight means small variations - `smoothing_top`
- e.g. `weight_apriori = 10`. - float
- (height scale) vertical profile smoothing at the top of the atmosphere
## options - e.g. `smoothing_top = 0.5`.
The `options` section handles the output options settings. - `weight_apriori`
- `output_transmission_spectra` - float
- boolean - weight of the a priori, low weight means small variations
- if True, output the transmission spectra - e.g. `weight_apriori = 10`.
- e.g. `output_transmission_spectra = True`. This enable the output of the transmission spectrum, plus the contributions to the transmission spectrum if the output contribution options are set to True (see below).
- `output_species_spectral_contributions` ## options
- boolean The `options` section handles the output options settings.
- if True, output the absorbers spectral contribution - `output_transmission_spectra`
- e.g. `output_species_spectral_contributions = True`. This enable the output of each absorber (defined in `species_names`) + CIA + Rayleigh contributions, individually. - boolean
- `output_cia_spectral_contribution` - if True, output the transmission spectra
- boolean - e.g. `output_transmission_spectra = True`. This enable the output of the transmission spectrum, plus the contributions to the transmission spectrum if the output contribution options are set to True (see below).
- if True, output the CIA spectral contribution - `output_species_spectral_contributions`
- e.g. `output_cia_spectral_contribution = True`. This enable the output of the CIA + Rayleigh total contributions. - boolean
- `output_thermal_spectral_contribution` - if True, output the absorbers spectral contribution
- boolean - e.g. `output_species_spectral_contributions = True`. This enable the output of each absorber (defined in `species_names`) + CIA + Rayleigh contributions, individually.
- if True, output the thermal spectral contribution - `output_cia_spectral_contribution`
- e.g. `output_thermal_spectral_contribution = True`. This enable the output of the thermal contribution (i.e. without light source), which is useful to calculate e.g. the Bond albedo. - boolean
- `output_fluxes` - if True, output the CIA spectral contribution
- boolean - e.g. `output_cia_spectral_contribution = True`. This enable the output of the CIA + Rayleigh total contributions.
- if True, output the radiosities without the effect of irradiance - `output_thermal_spectral_contribution`
- e.g. `output_fluxes = True`. This enable the output of the fluxes (i.e. the radiosities without light source). - boolean
- `output_hdf5` - if True, output the thermal spectral contribution
- boolean - e.g. `output_thermal_spectral_contribution = True`. This enable the output of the thermal contribution (i.e. without light source), which is useful to calculate e.g. the Bond albedo.
- if True, set the output format to HDF5 - `output_fluxes`
- e.g. `output_hdf5 = True`. This enable the output in HDF5, this is recommended as the HDF5 output is more complete. - boolean
- if True, output the radiosities without the effect of irradiance
## paths - e.g. `output_fluxes = True`. This enable the output of the fluxes (i.e. the radiosities without light source).
The `paths` section handles the output paths settings. - `output_hdf5`
- `path_data` - boolean
- string - if True, set the output format to HDF5
- path to molecular parameters files - e.g. `output_hdf5 = True`. This enable the output in HDF5, this is recommended as the HDF5 output is more complete.
- e.g. `path_data = '../data/'`.
- `path_cia` ## paths
- string The `paths` section handles the output paths settings.
- path to collision induced absorption files - `path_data`
- e.g. `path_cia = '../cia/'`. - string
- `path_clouds` - path to molecular parameters files
- string - e.g. `path_data = '../data/'`.
- path to the absorption cross sections files - `path_cia`
- e.g. `path_clouds ='../data/cloud_optical_constants/'`. - string
- `path_k_coefficients` - path to collision induced absorption files
- string - e.g. `path_cia = '../cia/'`.
- path to the k coefficients files - `path_clouds`
- e.g. `path_k_coefficients = '../data/k_coefficients_tables/R50/'`. - string
- `path_temperature_profile` - path to the absorption cross sections files
- string - e.g. `path_clouds ='../data/cloud_optical_constants/'`.
- path to the a-priori temperature profile file - `path_k_coefficients`
- e.g. `path_temperature_profile = '../inputs/atmospheres/temperature_profiles/'`. - string
- `path_thermochemical_tables` - path to the k coefficients files
- string - e.g. `path_k_coefficients = '../data/k_coefficients_tables/R50/'`.
- path to the thermochemical tables files - `path_temperature_profile`
- e.g. `path_thermochemical_tables = '../data/thermochemical_tables/'`. - string
- `path_vmr_profiles` - path to the a-priori temperature profile file
- string - e.g. `path_temperature_profile = '../inputs/atmospheres/temperature_profiles/'`.
- path to the VMR profiles - `path_thermochemical_tables`
- e.g. `path_vmr_profiles= '../inputs/atmospheres/vmr_profiles/'`. - string
- `path_light_source_spectra` - path to the thermochemical tables files
- string - e.g. `path_thermochemical_tables = '../data/thermochemical_tables/'`.
- path to the stellar spectra - `path_vmr_profiles`
- e.g. `path_light_source_spectra = '../data/stellar_spectra/'`. - string
- `path_outputs` - path to the VMR profiles
- string - e.g. `path_vmr_profiles= '../inputs/atmospheres/vmr_profiles/'`.
- path to molecular parameters files - `path_light_source_spectra`
- e.g. `path_outputs = '../outputs/exorem/'`. - string
- path to the stellar spectra
# Output file (HDF5) - e.g. `path_light_source_spectra = '../data/stellar_spectra/'`.
The units of each dataset are indicated under the `units` attribute. - `path_outputs`
Structure of the file: - string
``` - path to molecular parameters files
. - e.g. `path_outputs = '../outputs/exorem/'`.
├── model_parameters <- parameters used in the model
| ├── atmosphere # Output file (HDF5)
| | └── eddy_mode <- (scalar string) model eddy mode The units of each dataset are indicated under the `units` attribute.
| ├── clouds Structure of the file:
| | ├── fraction <- (scalar float) model cloud fraction ```
| | ├── mode <- (scalar string) model cloud mode .
| | ├── particle_density ├── model_parameters <- parameters used in the model
| | | ├── cloud1 <- (scalar float) cloud 1 particle density | ├── atmosphere
| | | ├── ... | | └── eddy_mode <- (scalar string) model eddy mode
| | | └── cloudn | ├── clouds
| | ├── particle_radius | | ├── fraction <- (scalar float) model cloud fraction
| | | ├── cloud1 <- (scalar float) cloud 1 particle radius | | ├── mode <- (scalar string) model cloud mode
| | | ├── ... | | ├── particle_density
| | | └── cloudn | | | ├── cloud1 <- (scalar float) cloud 1 particle density
| | ├── reference_wavenumber | | | ├── ...
| | | ├── cloud1 <- (scalar float) cloud 1 reference wavenumber | | | └── cloudn
| | | ├── ... | | ├── particle_radius
| | | └── cloudn | | | ├── cloud1 <- (scalar float) cloud 1 particle radius
| | └── sedimentation_parameter | | | ├── ...
| | ├── cloud1 <- (scalar float) cloud 1 sedimentation param. | | | └── cloudn
| | ├── ... | | ├── reference_wavenumber
| | └── cloudn | | | ├── cloud1 <- (scalar float) cloud 1 reference wavenumber
| ├── light_source | | | ├── ...
| | ├── effective_temperature <- (scalar float) light source T_eff | | | └── cloudn
| | ├── radius <- (scalar float) light source radius | | └── sedimentation_parameter
| | ├── range <- (scalar float) light source range | | ├── cloud1 <- (scalar float) cloud 1 sedimentation param.
| | └── spectral_irradiance <- (scalar float) light source irradiance | | ├── ...
| ├── retrieval | | └── cloudn
| | ├── chemistry_iteration_interval <- (scalar integer) | ├── light_source
| | ├── cloud_iteration_interval <- (scalar integer) | | ├── effective_temperature <- (scalar float) light source T_eff
| | ├── flux_error_bottom <- (scalar float) | | ├── radius <- (scalar float) light source radius
| | ├── flux_error_top <- (scalar float) | | ├── range <- (scalar float) light source range
| | ├── level_bottom <- (scalar integer) lowest level of retrieval | | └── spectral_irradiance <- (scalar float) light source irradiance
| | ├── level_top <- (scalar integer) highest level of retrieval | ├── retrieval
| | ├── n_burn_iterations <- (scalar integer) | | ├── chemistry_iteration_interval <- (scalar integer)
| | ├── n_iterations <- (scalar integer) | | ├── cloud_iteration_interval <- (scalar integer)
| | ├── n_non_adiabatic_iterations <- (scalar integer) | | ├── flux_error_bottom <- (scalar float)
| | ├── pressure_apriori <- (array float) pressures used in a-priori | | ├── flux_error_top <- (scalar float)
| | ├── smoothing_bottom <- (scalar float) | | ├── level_bottom <- (scalar integer) lowest level of retrieval
| | ├── smoothing_top <- (scalar float) | | ├── level_top <- (scalar integer) highest level of retrieval
| | ├── temperature_apriori <- (array float) temperatures used in a-priori | | ├── n_burn_iterations <- (scalar integer)
| | ├── tolerance <- (scalar float) | | ├── n_iterations <- (scalar integer)
| | └── weight_apriori <- (scalar float) | | ├── n_non_adiabatic_iterations <- (scalar integer)
| ├── species | | ├── pressure_apriori <- (array float) pressures used in a-priori
| | ├── absorber_is_at_equilibrium | | ├── smoothing_bottom <- (scalar float)
| | | ├── abs1 <- (scalar string) (T|F) if T, abs1 is at eq. | | ├── smoothing_top <- (scalar float)
| | | ├── ... | | ├── temperature_apriori <- (array float) temperatures used in a-priori
| | | └── absn | | ├── tolerance <- (scalar float)
| | ├── collision_induced_absorptions <- (scalar string) CIAs in model | | └── weight_apriori <- (scalar float)
| | ├── elemental_abundances | ├── species
| | | ├── Al <- (scalar float) Al/H ratio in model | | ├── absorber_is_at_equilibrium
| | | ├── ... | | | ├── abs1 <- (scalar string) (T|F) if T, abs1 is at eq.
| | | └── Zn | | | ├── ...
| | └── solar_elemental_abundances | | | └── absn
| | ├── Al <- (scalar float) Al/H solar ratio | | ├── collision_induced_absorptions <- (scalar string) CIAs in model
| | ├── ... | | ├── elemental_abundances
| | └── Zn | | | ├── Al <- (scalar float) Al/H ratio in model
| └── target | | | ├── ...
| ├── equatorial_radius_1e5Pa <- (scalar float) r_eq at 10^5 Pa | | | └── Zn
| ├── internal_temperature <- (scalar float) | | └── solar_elemental_abundances
| ├── latitude <- (scalar float) | | ├── Al <- (scalar float) Al/H solar ratio
| ├── mass <- (scalar float) | | ├── ...
| ├── polar_radius_1e5Pa <- (scalar float) r_pol at 10^5 Pa | | └── Zn
| └── radius_1e5Pa <- (scalar float) radius at 10^5 Pa | └── target
└── outputs <- model output | ├── equatorial_radius_1e5Pa <- (scalar float) r_eq at 10^5 Pa
├── layers | ├── internal_temperature <- (scalar float)
| ├── clouds | ├── latitude <- (scalar float)
| | ├── opacity | ├── mass <- (scalar float)
| | | ├── cloud1 <- (array float) cloud 1 tau at reference_wavenumber | ├── polar_radius_1e5Pa <- (scalar float) r_pol at 10^5 Pa
| | | ├── ... | └── radius_1e5Pa <- (scalar float) radius at 10^5 Pa
| | | └── cloudn └── outputs <- model output
| | ├── particle_radius ├── layers
| | | ├── cloud1 <- (array float) cloud 1 particle radius | ├── clouds
| | | ├── ... | | ├── opacity
| | | └── cloudn | | | ├── cloud1 <- (array float) cloud 1 tau at reference_wavenumber
| | └── volume_mixing_ratio | | | ├── ...
| | | ├── cloud1 <- (array float) cloud 1 vmr | | | └── cloudn
| | | ├── ... | | ├── particle_radius
| | | └── cloudn | | | ├── cloud1 <- (array float) cloud 1 particle radius
| ├── condensates | | | ├── ...
| | ├── pressure_condensation | | | └── cloudn
| | | ├── cond1 <- (scalar float) pressure of condensation of condensate 1 | | └── volume_mixing_ratio
| | | ├── ... | | | ├── cloud1 <- (array float) cloud 1 vmr
| | | └── condn | | | ├── ...
| | ├── volume_mixing_ratio_condensation | | | └── cloudn
| | | ├── cond1 <- (scalar float) vmr at condensation of condensate 1 | ├── condensates
| | | ├── ... | | ├── pressure_condensation
| | | └── condn | | | ├── cond1 <- (scalar float) pressure of condensation of condensate 1
| | └── volume_mixing_ratio_saturation | | | ├── ...
| | ├── cond1 <- (array float) saturation vmr of condensate 1 | | | └── condn
| | ├── ... | | ├── volume_mixing_ratio_condensation
| | └── condn | | | ├── cond1 <- (scalar float) vmr at condensation of condensate 1
| ├── eddy_diffusion_coefficient <- (array float) Kzz in layers | | | ├── ...
| ├── gravity <- (array float) gravity in layers | | | └── condn
| ├── isobaric_molar_heat_capacity<- (array float) C_p in layers | | └── volume_mixing_ratio_saturation
| ├── molar_mass <- (array float) molar mass in layers | | ├── cond1 <- (array float) saturation vmr of condensate 1
| ├── pressure <- (array float) pressure in layers | | ├── ...
| ├── temperature <- (array float) temperature in layers | | └── condn
| └── volume_mixing_ratios | ├── eddy_diffusion_coefficient <- (array float) Kzz in layers
| ├── absorbers | ├── gravity <- (array float) gravity in layers
| | ├── abs1 <- (array float) vmr of absorbing gas 1 | ├── isobaric_molar_heat_capacity<- (array float) C_p in layers
| | ├── ... | ├── molar_mass <- (array float) molar mass in layers
| | └── absn | ├── pressure <- (array float) pressure in layers
| ├── elements_gas_phase | ├── temperature <- (array float) temperature in layers
| | ├── Al <- (array float) weighted sum of the vmr of all gases containing element Al (ex. 0.7 H2, 0.1 H = 1.4 + 0.1 H) | └── volume_mixing_ratios
| | ├── ... | ├── absorbers
| | └── Zn | | ├── abs1 <- (array float) vmr of absorbing gas 1
| └── gases | | ├── ...
| ├── gas1 <- (array float) vmr of non-absorbing gas 1 | | └── absn
| ├── ... | ├── elements_gas_phase
| └── gasn | | ├── Al <- (array float) weighted sum of the vmr of all gases containing element Al (ex. 0.7 H2, 0.1 H = 1.4 + 0.1 H)
├── levels | | ├── ...
| ├── altitude <- (array float) altitude in levels | | └── Zn
| ├── delta_temperature_convection<- (array float) difference of temperature due to convection | └── gases
| ├── gradiant_temperature <- (array float) T gradiant | ├── gas1 <- (array float) vmr of non-absorbing gas 1
| ├── is_convective <- (array integer) (0|1) if 1, convection is occurring at the level | ├── ...
| ├── kernel_temperature <- (2D-array float) matrix K of retrieval | └── gasn
| ├── pressure <- (array float) pressure in levels ├── levels
| ├── radiosity_convective <- (array float) radiosity due to convection | ├── altitude <- (array float) altitude in levels
| ├── radiosity_error <- (array float) error on radiosity | ├── delta_temperature_convection<- (array float) difference of temperature due to convection
| ├── radiosity_internal <- (array float) internal radiosity | ├── gradiant_temperature <- (array float) T gradiant
| ├── temperature <- (array float) temperature in levels | ├── is_convective <- (array integer) (0|1) if 1, convection is occurring at the level
| ├── temperature_adiabatic <- (array float) adiabatic temperature in levels | ├── kernel_temperature <- (2D-array float) matrix K of retrieval
| ├── temperature_uncertainty <- (array float) uncertainty on temperatures | ├── pressure <- (array float) pressure in levels
| └── temperature_uncertainty_b <- (array float) variant of the uncertainty on temperatures | ├── radiosity_convective <- (array float) radiosity due to convection
├── run_quality | ├── radiosity_error <- (array float) error on radiosity
| ├── actual_internal_temperature <- (scalar float) actual T_int of the planet at the end of the run | ├── radiosity_internal <- (array float) internal radiosity
| ├── chi2_retrieval <- (scalar float) reduced chi2 of the retrieval | ├── temperature <- (array float) temperature in levels
| ├── delta_chi2_retrieval <- (scalar float) relative difference between the red. chi2 and the red. chi2 at the previous iteration | ├── temperature_adiabatic <- (array float) adiabatic temperature in levels
| ├── delta_temperature <- (array float) difference between the temperature and the temperature at the previous iteration | ├── temperature_uncertainty <- (array float) uncertainty on temperatures
| └── radiosity_actual_target_ratio <- (scalar float) ratio of the actual radiosity of the planet at the end of the run and the targeted radiosity (calculated with internal_temperature in input) | └── temperature_uncertainty_b <- (array float) variant of the uncertainty on temperatures
└── spectra ├── run_quality
├── emission | ├── actual_internal_temperature <- (scalar float) actual T_int of the planet at the end of the run
| ├── contributions | ├── chi2_retrieval <- (scalar float) reduced chi2 of the retrieval
| | ├── abs1 <- (array float) contribution of absorbing gas 1 + CIA + Rayleigh | ├── delta_chi2_retrieval <- (scalar float) relative difference between the red. chi2 and the red. chi2 at the previous iteration
| | ├── ... | ├── delta_temperature <- (array float) difference between the temperature and the temperature at the previous iteration
| | ├── absn | └── radiosity_actual_target_ratio <- (scalar float) ratio of the actual radiosity of the planet at the end of the run and the targeted radiosity (calculated with internal_temperature in input)
| | ├── cia_rayleigh <- (array float) contribution of CIA + Rayleigh └── spectra
| | └── thermal <- (array float) thermal contribution + CIA + Rayleigh ├── emission
| └── spectral_radiosity <- (array float) total spectral radiosity | ├── contributions
├── flux | | ├── abs1 <- (array float) contribution of absorbing gas 1 + CIA + Rayleigh
| ├── spectral_flux <- (array float) spectral flux | | ├── ...
| ├── spectral_flux_clear <- (array float) spectral flux without clouds | | ├── absn
| └── spectral_flux_cloud <- (array float) spectral flux with full cloud coverage | | ├── cia_rayleigh <- (array float) contribution of CIA + Rayleigh
├── transmission | | └── thermal <- (array float) thermal contribution + CIA + Rayleigh
| ├── contributions | └── spectral_radiosity <- (array float) total spectral radiosity
| | ├── abs1 <- (array float) contribution of absorbing gas 1 + CIA + Rayleigh ├── flux
| | ├── ... | ├── spectral_flux <- (array float) spectral flux
| | ├── absn | ├── spectral_flux_clear <- (array float) spectral flux without clouds
| | ├── cia_rayleigh <- (array float) contribution of CIA + Rayleigh | └── spectral_flux_cloud <- (array float) spectral flux with full cloud coverage
| | └── clouds <- (array float) cloud contribution + CIA + Rayleigh ├── transmission
| ├── derivative <- (2D-array float) derivative of the transmission spectrum | ├── contributions
| ├── transit_depth <- (array float) | | ├── abs1 <- (array float) contribution of absorbing gas 1 + CIA + Rayleigh
| ├── transit_depth_clear <- (array float) transit depth without clouds | | ├── ...
| ├── transit_depth_full_cover<- (array float) transit depth with full coverage | | ├── absn
| └── spectral_radiosity <- (array float) total spectral radiosity | | ├── cia_rayleigh <- (array float) contribution of CIA + Rayleigh
└── wavenumber <- (array float) wavenumber | | └── clouds <- (array float) cloud contribution + CIA + Rayleigh
``` | ├── derivative <- (2D-array float) derivative of the transmission spectrum
| ├── transit_depth <- (array float)
# Code | ├── transit_depth_clear <- (array float) transit depth without clouds
**This page is a work in progress** | ├── transit_depth_full_cover<- (array float) transit depth with full coverage
| └── spectral_radiosity <- (array float) total spectral radiosity
└── wavenumber <- (array float) wavenumber
```
# Code
**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. 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