diff --git a/README.md b/README.md index 8c13d08df826c76da9e3d6f6ea2009d898bc3f58..876ccf6315c6c3d8d5dd5e154aebbc6cecf6d6cf 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -**Scripts for processing of WRF-CHEM files to PALM dynamic driver.** +#Scripts for processing of WRF-CHEM files to PALM dynamic driver.# Version: v.1.0 @@ -27,12 +27,11 @@ mid-latitudes. The scripts support both variants of WRF-CHEM vertical levels - the sigma levels (default until WRF version 3.*) and the hybrid levels (default since WRF 4.*). However, it is necessary to correctly configure this option via the setting `wrf_hybrid_levs = True/False`. -# Configuration parameters +## Configuration parameters Description of the particular configuration options are (defaults are in parenthesis): -## Domain and case related configurations -* `domain` - - Name of the simulation case (""). +### Domain and case related configurations +* `domain` Name of the simulation case (""). * `resolution` Name of the particular domain resolution scenario (""). * `scenario` Name of the individual scenario in the case (""). * `nested_domain` False indicates parent and True nested domain. (False). @@ -40,8 +39,8 @@ Description of the particular configuration options are (defaults are in parenth * `dynamic_driver_file` File name of output dynamic driver (""). * `grid_from_static` True - import from static driver, False - given in config (True). * `static_driver_file` File name of the static driver in case of grid_from_static (""). -* `proj_palm` Reference coordinate system of PALM simulation ("EPSG:32633"). -* `proj_wgs84` Reference coordinate system of lon-lat projection ("EPSG:4326"). +* `proj_palm` Reference coordinate system of PALM simulation ("EPSG:32633"). +* `proj_wgs84` Reference coordinate system of lon-lat projection ("EPSG:4326"). * `dz` Height of the PALM vertical grid layer (0.0). The default value dz = 0.0 means dz is assigned from dx. * `nz` Number of vertical layers of PALM domain (200). @@ -52,7 +51,7 @@ Description of the particular configuration options are (defaults are in parenth * `origin_time` Origin time of the PALM simulation in the format YYYY-MM-DD hh:mm:ss (""). Default reads from static driver. * `simulation_hours` Extent of the simulation in hours. -## WRF-CHEM related configurations +### WRF-CHEM related configurations * `wrf_dir_name` File path of the wrf-chem input files (""). * `wrf_file_mask` File mask of the wrf-chem input files ("wrfout_*.e000") * `wrf_hybrid_levs` True means hybrid levels in WRF files, False means sigma levels (True). @@ -72,13 +71,13 @@ Description of the particular configuration options are (defaults are in parenth * `wrf_rad_file_mask` File mask of the wrf radiation input files ("auxhist6_*"). The default setting reads radiation from WRF auxiliary history files. This setting allows to use finer time step for WRF radiation outputs than for other values. * `radiation_smoothing_distance` Smoothing distance for radiation values in m (10000.0). -## Horizontal parameters of the PALM domain which have to be set in case of grid_from_static = False +### Horizontal parameters of the PALM domain which have to be set in case of grid_from_static = False * `nx, ny` Number of horizontal grids of the domain in x and y directions. * `dx, dy` Grid cell size of the domain in x and y directions. * `origin_x, origin_y` Origin x and y of the domain. * `origin_z` Origin of the domain in the vertical direction. -### Major Changes from wrf + CAMx scripts made to wrf_chem_for_palm +#### Major Changes from wrf + CAMx scripts made to wrf_chem_for_palm - Proj future warning resolved - Chemical species are read from wrf-chem files and interpolated at the same time as the dynamic variables - Interpolated files are saved to a different directory than the wrf-chem data files