@@ -26,14 +26,17 @@ The `output_files` section allows you to personalize the names of the output fil
...
@@ -26,14 +26,17 @@ The `output_files` section allows you to personalize the names of the output fil
- 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`.
- units of the file: wavenumber in cm-1, flux in W.m-2/cm-1
-`temperature_profile_file_prefix`
-`temperature_profile_file_prefix`
- string
- string
- prefix of the temperature profile files
- prefix of the temperature profile files
- 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`.
- 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`.
- units of the file: pressure in Pa, temperature in K
-`vmr_file_prefix`
-`vmr_file_prefix`
- string
- string
- prefix of the volume mixing ratio profiles files
- prefix of the volume mixing ratio profiles files
- 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`.
- 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`.
- units of the file: pressure in Pa, vmr in mol/mol
-`output_files_suffix`
-`output_files_suffix`
- string
- string
- suffix of the output files
- suffix of the output files
...
@@ -116,6 +119,7 @@ The `light_source_parameters` section handles the light source (star) settings.
...
@@ -116,6 +119,7 @@ The `light_source_parameters` section handles the light source (star) settings.
- string
- string
- spectrum of the light source
- spectrum of the light source
- 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. 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`.
- units of the file for BT-Settl: wavelength in angstrom, flux in erg.s-1.cm-2.a-1
-`incidence_angle` [unused parameter]
-`incidence_angle` [unused parameter]
- float
- float
- (deg) incident light source light relative to the normal of the atmosphere
- (deg) incident light source light relative to the normal of the atmosphere
...
@@ -145,7 +149,7 @@ The `atmosphere_parameters` section handles the atmospheric settings.
...
@@ -145,7 +149,7 @@ The `atmosphere_parameters` section handles the atmospheric settings.
- 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. `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.
-`metallicity`
-`metallicity`
- float
- float
- (solar metallicity) atmospheric metallicity
- (times solar metallicity) atmospheric metallicity
- 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. `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_levels`
-`n_levels`
- integer
- integer
...
@@ -226,6 +230,7 @@ The `species_parameters` section handles the atmospheric elemental abundances, w
...
@@ -226,6 +230,7 @@ The `species_parameters` section handles the atmospheric elemental abundances, w
- string
- string
- VMR profiles file, ignored if load_vmr_profiles is False
- VMR profiles file, ignored if load_vmr_profiles is False
- e.g. `vmr_profiles_file = 'vmr_example_ref.dat'`. The file must be in the `path_vmr_profiles` directory.
- e.g. `vmr_profiles_file = 'vmr_example_ref.dat'`. The file must be in the `path_vmr_profiles` directory.
- units: pressure in Pa, vmr in mol/mol
## spectrum_parameters
## spectrum_parameters
The `spectrum_parameters` section handles the spectral range and resolution of the calculated spectrum.
The `spectrum_parameters` section handles the spectral range and resolution of the calculated spectrum.
...
@@ -250,7 +255,7 @@ The `clouds_parameters` section handles the clouds settings. The cloud optical c
...
@@ -250,7 +255,7 @@ The `clouds_parameters` section handles the clouds settings. The cloud optical c
- 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.
- 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.
-`cloud_fraction`
-`cloud_fraction`
- float
- float
- cloud cover fraction
- cloud cover fraction (dimensionless)
- 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`.
- 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_names`
-`cloud_names`
- list of strings
- list of strings
...
@@ -262,7 +267,7 @@ The `clouds_parameters` section handles the clouds settings. The cloud optical c
...
@@ -262,7 +267,7 @@ The `clouds_parameters` section handles the clouds settings. The cloud optical c
- 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)).
- 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)).
-`sedimentation_parameter`
-`sedimentation_parameter`
- list of floats
- list of floats
- sedimentation parameter of the clouds
- sedimentation parameter (dimensionless) of the clouds
- 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)).
- 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)).
-`cloud_particle_density`
-`cloud_particle_density`
- list of floats
- list of floats
...
@@ -274,7 +279,7 @@ The `clouds_parameters` section handles the clouds settings. The cloud optical c
...
@@ -274,7 +279,7 @@ The `clouds_parameters` section handles the clouds settings. The cloud optical c
- e.g. `supersaturation_parameter = 0.003, 0.003`.
- e.g. `supersaturation_parameter = 0.003, 0.003`.
-`sticking_efficiency`
-`sticking_efficiency`
- list of floats
- list of floats
- sticking efficiency of the clouds
- sticking efficiency (dimensionless) of the clouds
- e.g. `sticking_efficiency = 1.0, 1.0`.
- e.g. `sticking_efficiency = 1.0, 1.0`.
-`reference_wavenumber`
-`reference_wavenumber`
- list of floats
- list of floats
...
@@ -291,6 +296,7 @@ The `retrieval_parameters` section handles the retrieval/inversion settings.
...
@@ -291,6 +296,7 @@ The `retrieval_parameters` section handles the retrieval/inversion settings.
- string
- string
- a-priori temperature profile file
- 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.
- e.g. `temperature_profile_file = 'temperature_profile_example_ref.dat' `. The file must be in the `path_temperature_profile` directory.
- units: pressure in Pa, temperature in K
-`retrieval_level_bottom`
-`retrieval_level_bottom`
- integer
- integer
- min level for flux retrieval
- min level for flux retrieval
...
@@ -301,11 +307,11 @@ The `retrieval_parameters` section handles the retrieval/inversion settings.
...
@@ -301,11 +307,11 @@ The `retrieval_parameters` section handles the retrieval/inversion settings.
- 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`.
- 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`.
-`retrieval_flux_error_bottom`
-`retrieval_flux_error_bottom`
- float
- float
- relative flux error at the bottom of the atmospheric grid
- relative flux error (dimensionless) at the bottom of the atmospheric grid
- 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.
- 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.
-`retrieval_flux_error_top`
-`retrieval_flux_error_top`
- float
- float
- relative flux error at the top of the atmospheric grid
- relative flux error (dimensionless) at the top of the atmospheric grid
- 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.
- 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.
