Update Getting started authored by Doriann Blain's avatar Doriann Blain
In this section we will describe how to quickly run an *Exo-REM* simulation. We will use the `inputs/example.nml` coming with all [distributed versions](https://gitlab.obspm.fr/dblain/exorem/-/tree/master/dist) of *Exo-REM* as a starting point. Before, please take the time to read the README. In this section we will describe how to quickly run an *Exo-REM* simulation. We will use the `inputs/example.nml` coming with all [distributed versions](https://gitlab.obspm.fr/dblain/exorem/-/tree/master/dist) of *Exo-REM* as a starting point. Before, please take the time to read the README and/or the [].
Want some help with convergence issues ? Check the related page on this wiki. Want some help with convergence issues ? Check the related page on this wiki.
...@@ -15,11 +15,11 @@ Summary: ...@@ -15,11 +15,11 @@ Summary:
- [Better figures](#better-figures) - [Better figures](#better-figures)
# Prerequisites # Prerequisites
If you downloaded the archive in the [_dist_](https://gitlab.obspm.fr/dblain/exorem/-/tree/master/dist) directory, you should have everything you need, except a stellar spectrum (see point 4 below). Otherwise, check the following: If you downloaded the archive in the [_dist_](https://gitlab.obspm.fr/dblain/exorem/-/tree/master/dist) directory, you should have everything you need, except a stellar spectrum (see point 4 below), and more importantly the k-coefficients tables (see point 3 below). Otherwise, check the following:
1. Verify if the collision-induced absorption (CIA) files are inside the _data/cia_ directory. If you want to use other CIA files, respect the same format and use "CIAname.cia.txt" as file name (e.g. "H2-He.cia.txt"). 1. Verify if the collision-induced absorption (CIA) files are inside the _data/cia_ directory. If you want to use other CIA files, respect the same format and use "CIAname.cia.txt" as file name (e.g. "H2-He.cia.txt").
2. If you intend to use clouds, verify if the cloud optical constants (OCST) files are inside the _data/cloud_optical_constants_ directory. If you want to use other OCST files, respect the same format and use "cloudName.ocst.txt" as file name (e.g. "H2O.ocst.txt"). 2. If you intend to use clouds, verify if the cloud optical constants (OCST) files are inside the _data/cloud_optical_constants_ directory. If you want to use other OCST files, respect the same format and use "cloudName.ocst.txt" as file name (e.g. "H2O.ocst.txt").
3. Put k-coefficients of desired absorbers inside the _data/k_coefficients_tables_ directory. You can use directly *CKC* outputs converted into HDF5 using *txt2h5*, or e.g. *[petitRADTRANS](https://petitradtrans.readthedocs.io/en/latest/content/available_opacities.html)* k-tables. If your absorber name is "absorberName", the lines file needs to be named "absorberName.ktable.exorem.h5" (e.g. H2O.ktable.exorem.h5). You can download compressed *Exo-REM* k-tables [here](https://gitlab.obspm.fr/dblain/exorem/-/tree/master/data/k_coefficients). 3. Put k-coefficients of desired absorbers inside the _data/k_coefficients_tables_ directory. You can use directly *CKC* outputs converted into HDF5 using *txt2h5*, or e.g. *[petitRADTRANS](https://petitradtrans.readthedocs.io/en/latest/content/available_opacities.html)* k-tables. If your absorber name is "absorberName", the lines file needs to be named "absorberName.ktable.exorem.h5" (e.g. H2O.ktable.exorem.h5). You can download compressed *Exo-REM* k-tables [here](https://lesia.obspm.fr/exorem/).
4. If you intend to use stellar spectra, you can download them e.g. [here](http://svo2.cab.inta-csic.es/theory/newov2/index.php?models=bt-settl). You **must** modify them in order to respect the *Exo-REM* data format (see section data format). 4. If you intend to use stellar spectra, you can download them e.g. [here](http://svo2.cab.inta-csic.es/theory/newov2/index.php?models=bt-settl). You **must** modify them in order to respect the *Exo-REM* data format (see section data format).
5. Verify if all the condensates and gases thermochemical tables are in the _data/thermochemical_tables_ directory. If you want to add more species to the chemical model, respect the same format and use "speciesName.tct.dat" as file name (e.g. "H2O.tct.dat"). 5. Verify if all the condensates and gases thermochemical tables are in the _data/thermochemical_tables_ directory. If you want to add more species to the chemical model, respect the same format and use "speciesName.tct.dat" as file name (e.g. "H2O.tct.dat").
6. Put a temperature profile as a priori inside the _inputs/atmospheres/temperature_profiles_ directory. The *Exo-REM* data format must be respected. You should have received an example of such a file with your *Exo-REM* distribution. 6. Put a temperature profile as a priori inside the _inputs/atmospheres/temperature_profiles_ directory. The *Exo-REM* data format must be respected. You should have received an example of such a file with your *Exo-REM* distribution.
... ...
......