|
|
# General section
|
|
|
|
|
|
The general section of the configuration file is used to define the main paths (input, output, data), name of the output file, time step configuration and output units.
|
|
|
|
|
|
A further description of each parameter is presented below.
|
|
|
|
|
|
## Example
|
|
|
```text
|
|
|
log_level = 3
|
|
|
input_dir = /home/user/HERMES/HERMES_IN
|
|
|
data_path = /home/user/HERMES/datasets
|
|
|
output_dir = /home/user/HERMES/HERMES_OUT
|
|
|
output_name = HERMESv3_<date>.nc
|
|
|
start_date = 2010/01/01 00:00:00
|
|
|
# end_date = 2010/01/01 00:00:00
|
|
|
output_timestep_type = hourly
|
|
|
output_timestep_num = 24
|
|
|
output_timestep_freq = 1
|
|
|
compression_level = 4
|
|
|
```
|
|
|
|
|
|
## Options description
|
|
|
| **Option** | **Details** |
|
|
|
| :--------: | :----- |
|
|
|
| _log_level_ | **1**: Low log |
|
|
|
| | **2**: Medium Log |
|
|
|
| | **3**: Complete Log |
|
|
|
|_input_dir_|```<HERMES_PATH>/IN```[^1]. The next paths that contains ```<input_dir>``` will be completed with the _input_dir_ value placed here.|
|
|
|
|_data_path_|Path to the folder that contains all the needed datasets as input. More details below.|
|
|
|
|_output_dir_|```<HERMES_PATH>/OUT```[^1]|
|
|
|
|_output_name_|Name of the output file. You can add the string ```<date>``` that will be replaced by the starting date of the simulation day. The complete path to the output file is the combination of _output_path_ and _output_name_.|
|
|
|
|_start_date_|Starting Date to simulate (UTC). Date formats accepted by HERMESv3_GR are detailed below.|
|
|
|
|_end_date_|[**OPTIONAL**] If you want to simulate more than one day you have to specify the ending date of simulation in this parameter. If it is not set then end_date = start_date. |
|
|
|
|_output_timestep_type_|**hourly**: For hourly time step outputs.|
|
|
|
| |**daily**: For daily time steps outputs.|
|
|
|
| |**monthly**: For monthly time steps outputs.|
|
|
|
| |**yearly**: For yearly time steps outputs.|
|
|
|
|_output_timestep_num_| Number of time steps to simulate. |
|
|
|
|_output_timestep_freq_| Frequency between time steps. |
|
|
|
|_compression_level_| Level of compression of the outputs from 0 to 9; 0 corresponds to no compression and 9 to maximum compression. |
|
|
|
|
|
|
[^1]: \<HERMES_PATH> is the path where you have the cloned the HERMESv3_GR project.
|
|
|
|
|
|
#### Log levels
|
|
|
|
|
|
* **1**: Low information of the execution progress.
|
|
|
* **2**: Medium information of the execution progress.
|
|
|
* **3**: Detailed log with the information of each step performed by the model to process the emissions (recommended for debugging).
|
|
|
|
|
|
### data_path
|
|
|
The _data_path_ configuration option is used to define the common directory path where all the emission inventories used by HERMESv3_GR are stored.
|
|
|
|
|
|
The complete path to each specific emission inventory file is specified in the [emission invetories selection file](examples_cross_table.md) detailed in the [inventories selection page](user_guide_section_inventories.md).
|
|
|
|
|
|
### Date formats
|
|
|
HERMESv3_GR accepts the following date formats:
|
|
|
+ YYYYMMDD: ```20150101```
|
|
|
+ YYYYMMDDhh: ```2015010100```
|
|
|
+ YYYYYMMDD.hh: ```20150101.00```
|
|
|
+ YYYY/MM/DD: ```2015/01/01```
|
|
|
+ YYYY/MM/DD_hh: ```2015/01/01_00```
|
|
|
+ YYYY/MM/DD_hh:mm:ss: ```2015/01/01_00:00:00```
|
|
|
+ YYYY/MM/DD hh:mm:ss: ```2015/01/01 00:00:00```
|
|
|
+ YYYY-MM-DD_hh: ```2015-01-01_00```
|
|
|
+ YYYY-MM-DD_hh:mm:ss: ```2015-01-01_00:00:00```
|
|
|
+ YYYY-MM-DD hh:mm:ss: ```2015-01-01 00:00:00```
|
|
|
|
|
|
[Go to User guide page](user_guide) |
|
|
\ No newline at end of file |