Changes between Version 2 and Version 3 of doc/app/iofiles/inifor

Timestamp:

Oct 30, 2018 9:10:13 AM (7 years ago)

Author:

eckhard

Comment:

Use tables instead of code listings for namelist parameters and command-line options

doc/app/iofiles/inifor

@@ -19 +19 @@
 === inipar ===
 
-{{{
-nx, ny, nz - number of PALM-4U grid points in x, y, and z direction
-dx, dy, dz(10) - PALM-4U grid spacings in x, y, and z direction [m]
-dz_stretch_level - height above which the grid will be stretched [m]
-dz_stretch_factor - factor by which the grid will be stretched
-dz_max - maximum vertical grid spacing [m]
-dz_stretch_level_start(9) - array of height levels above which the grid is
-to be stretched vertically [m]
-dz_stretch_level_end(9) - array of height levels until which the grid is to
-be stretched vertically [m]
-longitude, latitude - geographical coordinates of the PALM-4U origin [deg]
-}}}
+||='''Parameter name''' =||='''Default value''' =||='''Description''' =||
+|| nx, ny, nz || None || Number of PALM-4U grid points in x, y, and z direction ||
+|| dx, dy, dz(10) || None || PALM-4U grid spacings in x, y, and z direction [m] ||
+|| dz_stretch_level || -9999999.9 || Height above which the grid will be stretched [m] ||
+|| dz_stretch_factor || 1.08 || Factor by which the grid will be stretched ||
+|| dz_max || 1000.0 || Maximum vertical grid spacing [m] ||
+|| dz_stretch_level_start(9) || -9999999.9 || Array of height levels above which the grid is to be stretched vertically [m] ||
+|| dz_stretch_level_end(9) || 9999999.9 || Array of height levels until which the grid is to be stretched vertically [m] ||
+|| longitude, latitude || 0.0 || Geographical coordinates of the PALM-4U origin [deg] ||
+
 
 === d3par ===
 
-{{{
-end_time - PALM-4U simulation time. INIFOR will produce hourly forcing data
-    from the start date (see -d command-line option) to end_time seconds
-    thereafter. [s]
-}}}
+||='''Parameter name''' =||='''Default value''' =||='''Description''' =||
+|| end_time || 0.0 || PALM-4U simulation time. INIFOR will produce hourly forcing data from the start date (see -d command-line option) to end_time seconds thereafter. [s] ||
+
 
 === Example namelist file ===
@@ -56 +52 @@
 == Available command-line options ==
 
-{{{
--d, --date, -date <date>:
-    Start date of the simulation in the form YYYYMMDD of YYYYMMDDHH. If no
-    hours (HH) are given, INIFOR assumes that the simulation starts at O UTC
-    on that day. Default: 20130721
-    
--i, --init-mode, -mode <mode>:
-    Set the PALM-4U initialization mode. INIFOR can provide initial conditions
-    as either profiles or three-dimensional fields. The corresponding modes
-    are 'profile' and 'volume'. Default: volume
-
--l, --hhl-file, -hhl <netCDF file>:
-    Location of the netCDF file containing the vertical COSMO-DE grid levels,
-    specifically the heights of half levels (hhl, i.e. vertical cell faces).
-    Default: <scenario path>/hhl.nc
-
--n, --namelist <namelist file>:
-    Location of the PALM-4U namelist file. INIFOR expects the file to contain
-    two namelists, inipar and d3par, from which it will read grid parameters
-    and the simulation time. Default: ./namelist
-
--o, --output <output file>:
-    Name of the INIFOR output file, i.e. the PALM-4U dynamic driver.
-    Default: ./palm-4u-input.nc
-
--p, --path, -path <scenario path>:
-    Scenario path, i.e. the path of the meteorological input data. Default: ./
-
--r, --surface-pressure, -p0 <pressure>:
-    Surface pressure at z=0 in the PALM-4U domain [Pa].
-    Default: 1e5
-
--s, --soil-file, -soil <netCDF file>:
-    Location of the netCDF file containing the COSMO-DE soil type map.
-    Default: <scenario path>/soil.nc
-
--t, --static-driver, -static <netCDF file>:
-    Location of the netCDF file containing the static driver file for the case
-    to be simulated with PALM-4U. Optional parameter. Default: None
-
--u, --geostrophic-u, -ug <velocity>:
-    Specifies the geostrophic wind in x direction [m/s]. Default: 0
-
--v, --geostrophic-v, -vg <velocity>:
-    Specifies the geostrophic wind in y direction [m/s]. Default: 0
-
---version:
-    Output version number and exit.
-
--z, --elevation, -z0 <height>: Specifies the elevation of the PALM-4U domain
-    above sea level [m]. Default: 35
-}}}
+||='''Option''' =||='''Default value''' =||='''Description''' =||
+|-----------
+||-a   ||" "  ||activation string list  ||
+||-d, --date <date> || 20130721 || Start date of the simulation in the form YYYYMMDD of YYYYMMDDHH. If no hours (HH) are given, INIFOR assumes that the simulation starts at O UTC on that day. ||
+||-i, --init-mode <mode> || volume || Set the PALM-4U initialization mode. INIFOR can provide initial conditions as either profiles or three-dimensional fields. The corresponding modes are 'profile' and 'volume'. ||
+|| -l, --hhl-file <netCDF file> ||  <scenario path>/hhl.nc || Location of the netCDF file containing the vertical COSMO-DE grid levels, specifically the heights of half levels (hhl, i.e. vertical cell faces). ||
+|| -n, --namelist <namelist file> || ./namelist || Location of the PALM-4U namelist file. INIFOR expects the file to contain two namelists, inipar and d3par, from which it will read grid parameters and the simulation time. ||
+|| -o, --output <output file> || ./palm-4u-input.nc || Name of the INIFOR output file, i.e. the PALM-4U dynamic driver. ||
+|| -p, --path <scenario path> || ./ || Scenario path, i.e. the path of the meteorological input data. ||
+|| -r, --surface-pressure <pressure> || 1e5 || Surface pressure at z=0 in the PALM-4U domain [Pa]. ||
+|| -s, --soil-file <netCDF file> || <scenario path>/soil.nc || Location of the netCDF file containing the COSMO-DE soil type map. ||
+|| -t, --static-driver <netCDF file> || None || Location of the netCDF file containing the static driver file for the case to be simulated with PALM-4U. Optional parameter. ||
+|| -u, --geostrophic-u <velocity> || 0 || Specifies the geostrophic wind in x direction [m/s]. ||
+|| -v, --geostrophic-v <velocity> || 0 || Specifies the geostrophic wind in y direction [m/s]. ||
+|| --version || N/A || Output version number and exit. ||
+|| -z, --elevation <height> || 35 || Specifies the elevation of the PALM-4U domain above sea level [m]. ||
 
 
 == Additional command-line options ==
 
-{{{
---flow-prefix <prefix>:
-    Set the file prefix of flow input files. Default: laf
-
---radiation-prefix <prefix>:
-    Set the file prefix of radiation input files. Default: laf
-
---soil-prefix <prefix>:
-    Set the file prefix of soil input files. Default: laf
-
---soilmoisture-prefix <prefix>:
-    Set the file prefix of soil moisture input files. Default: laf
-}}}
+||='''option''' =||='''default value''' =||='''description''' =||
+|| --flow-prefix <prefix> || laf || Set the file prefix of flow input files. ||
+|| --radiation-prefix <prefix> || laf || Set the file prefix of radiation input files. ||
+|| --soil-prefix <prefix> || laf ||Set the file prefix of soil input files. ||
+|| --soilmoisture-prefix <prefix> || laf || Set the file prefix of soil moisture input files. ||