|
|
# Executables
|
|
|
Once the installation of HERMESv3_GR is finished the following 4 executables will be available:
|
|
|
|
|
|
1. ```hermesv3_gr```: Main HERMESv3_GR model.
|
|
|
2. ```hermesv3_gr_copy_config_files```: Used to copy a sample of the needed configuration files and temporal, vertical and speciation profiles.
|
|
|
3. ```hermesv3_gr_copy_preproc_files```: Used to download the scripts to transform the original emission inventories to the HERMESv3_GR conventions.
|
|
|
4. ```hermesv3_gr_download_benchmark ```: Used to download HERMESv3_GR benchmark test case.
|
|
|
|
|
|
This section describes how to use each one of them.
|
|
|
|
|
|
## hermesv3_gr_copy_config_files
|
|
|
This executable allows to the user to copy a sample of the needed configuration files and profiles (temporal, vertical, speciation) to run HERMESv3_GR model.
|
|
|
|
|
|
In order to execute the file, you need to define the __HERMES_IN__ path in which the configuration files and the profiles will be stored:
|
|
|
```bash
|
|
|
hermesv3_gr_copy_config_files '/home/user/HERMES/HERMES_IN'
|
|
|
```
|
|
|
|
|
|
Once executed, the following files will appear stored in the __HERMES_IN__ path:
|
|
|
- conf
|
|
|
- [EI_configuration.csv](examples_cross_table.md)
|
|
|
- [hermes.conf](user_guide)
|
|
|
- data
|
|
|
- [global_attributes.csv](examples_global_attributes.md)
|
|
|
- profiles
|
|
|
- speciation
|
|
|
- [MolecularWeights.csv](examples_profiles_molecular_weights.md)
|
|
|
- [Speciation_profile_cb05_aero5_CMAQ.csv](examples_profiles_speciation.md)
|
|
|
- [Speciation_profile_cb05_aero6_CMAQ.csv](examples_profiles_speciation.md)
|
|
|
- [Speciation_profile_cb05e51_aero6_CMAQ.csv](examples_profiles_speciation.md)
|
|
|
- [Speciation_profile_cb05_aero5_MONARCH.csv](examples_profiles_speciation.md)
|
|
|
- [Speciation_profile_radm2_madesorgam_WRF_CHEM.csv](examples_profiles_speciation.md)
|
|
|
- temporal
|
|
|
- [TemporalProfile_Daily.csv](examples_profiles_daily.md)
|
|
|
- [TemporalProfile_Hourly.csv](examples_profiles_hourly.md)
|
|
|
- [TemporalProfile_Monthly.csv](examples_profiles_monthly.md)
|
|
|
- [tz_world_country_iso3166.csv](examples_profiles_world_info.md)
|
|
|
- vertical
|
|
|
- [Benchmark_15layers_vertical_description.csv](examples_profiles_vertical.md)
|
|
|
- [Vertical_profile.csv](examples_vertical_description.md)
|
|
|
|
|
|
## hermesv3_gr_download_benchmark
|
|
|
This executable allows the user to download the input and benchmark comparison data to [test the build of HERMESv3_GR](../short_examples).
|
|
|
This step is not required to run HERMESv3_GR but it is recommended for new users.
|
|
|
The command to execute the file is as follows:
|
|
|
```bash
|
|
|
hermesv3_gr_download_benchmark '/home/user/HERMES/'
|
|
|
```
|
|
|
|
|
|
## hermesv3_gr_copy_preproc_files
|
|
|
Original gridded emission inventories need to be pre-processed in order to fullfill the input data requirements of HERMESv3_GR.
|
|
|
This executable allows the user to download the needed scripts to pre-process the original emission files.
|
|
|
|
|
|
The command to execute the file is as follows:
|
|
|
```bash
|
|
|
hermesv3_gr_copy_preproc_files '/home/user/HERMES/preproc'
|
|
|
```
|
|
|
|
|
|
Once executed, the following scripts will appear in the preproc folder:
|
|
|
- ceds_preproc.py
|
|
|
- eclipsev5a_preproc.py
|
|
|
- edgarv432_ap_preproc.py
|
|
|
- edgarv432_voc_preproc.py
|
|
|
- emep_preproc.py
|
|
|
- gfas12_preproc.py
|
|
|
- htapv2_preproc.py
|
|
|
- tno_mac_iii_preproc.py
|
|
|
- tno_mac_iii_preproc_voc_ratios.py
|
|
|
- wiedinmyer_preproc.py
|
|
|
|
|
|
{+ TODO +} {- Add CSV files -}
|
|
|
|
|
|
The pre-processing scripts run using the same libraries installed during the HERMESv3_GR [installation process](user_guide_how_to_install.md).
|
|
|
|
|
|
Each one of the scripts has its own requirements to be set in the __CONFIGURATION PARAMETERS__ section on the top of the script.
|
|
|
|
|
|
In order to execute the scripts, the user needs to first download the corresponding original emission inventory. A description of the emission inventories that HERMESv3_GR can currently process, together with the official website/contact for downloading the, can be found [here](user_guide_emission_inventories.md)
|
|
|
|
|
|
## hermesv3_gr
|
|
|
hermesv3_gr is the executable of the HERMESv3_GR model.
|
|
|
|
|
|
In order to execute it, the path to the configuration file needs to be provided as follows:
|
|
|
|
|
|
```bash
|
|
|
hermesv3_gr --my-config '/home/user/HERMES/HERMES_IN/conf/hermes.conf'
|
|
|
|
|
|
# or
|
|
|
|
|
|
hermesv3_gr -c '/home/user/HERMES/HERMES_IN/conf/hermes.conf'
|
|
|
```
|
|
|
|
|
|
In order to execute HERMESv3_GR in parallell, the number of processors should also be defined. In the following example, HERMESv3_GR is executed using 24 cpus:
|
|
|
|
|
|
```bash
|
|
|
mpirun -np 24 hermesv3_gr --my-config '/home/user/HERMES/HERMES_IN/conf/hermes.conf'
|
|
|
|
|
|
# or
|
|
|
|
|
|
mpirun -np 24 hermesv3_gr -c '/home/user/HERMES/HERMES_IN/conf/hermes.conf'
|
|
|
```
|
|
|
|
|
|
Configuration options can be passed to HERMESv3 via the configuration file (hermes.conf), arguments or a combination of both.
|
|
|
The arguments passed by command line take priority from the one that appears in the configuration file. To adquire more information about the arguments you can call the hermes help:
|
|
|
|
|
|
```bash
|
|
|
hermesv3_gr --help
|
|
|
|
|
|
# or
|
|
|
|
|
|
hermesv3_gr -h
|
|
|
```
|
|
|
|
|
|
|
|
|
[Go to User guide page](user_guide) |