Changeset 3456 for palm/trunk/UTIL/inifor/README

Timestamp:

Oct 30, 2018 2:29:54 PM (6 years ago)

Author:

eckhard

Message:

inifor: Removed surface forcing and internal arrays from netCDF output

File:

• palm/trunk/UTIL/inifor/README (modified) (8 diffs)

palm/trunk/UTIL/inifor/README

@@ -1 @@
-# INIFOR - Mesoscale Interface for Initializing and Forcing PALM-4U (v1.4.0)
+# INIFOR - Mesoscale Interface for Initializing and Forcing PALM-4U (v1.4.1)
 
 INIFOR provides the meteorological fields required to initialize and drive the
@@ -64 +64 @@
 
 
-### AVAILABLE NAMELIST PARAMETERS
+### NAMELIST PARAMETERS
 
 INIFOR mirrors a subset of the PALM-4U's Fortran namelists `inipar` and `d3par`
@@ -103 +103 @@
 
 
-### AVAILABLE COMMAND-LINE PARAMETERS
+### COMMAND-LINE PARAMETERS
+
+#### INIFOR configuration
+
     --averaging-mode <mode>:
         Selects how averaged quantities (large-scale forcing terms) are computed.
@@ -114 +117 @@
 
     -d, --date, -date <date>:
-        Start date of the simulation in the form YYYYMMDD of YYYYMMDDHH. If no
+        Start date of the simulation in the form YYYYMMDD or YYYYMMDDHH. If no
         hours (HH) are given, INIFOR assumes that the simulation starts at O UTC
         on that day. Default: 20130721
@@ -122 +125 @@
         as either profiles or three-dimensional fields. The corresponding modes
         are 'profile' and 'volume'. Default: volume
+
+    -r, --surface-pressure, -p0 <pressure>:
+        Manually set the pressure at z=0 in the PALM-4U domain [Pa]. If not
+        given, the surface pressure is computed from the COSMO pressure field.
+
+    -u, --geostrophic-u, -ug <velocity>:
+        Manually specify the geostrophic wind in x direction [m/s]. If not
+        given, the geostrophic wind is computed from the COSMO pressure field.
+
+    -v, --geostrophic-v, -vg <velocity>:
+        Manually specify the geostrophic wind in y direction [m/s]. If not
+        given, the geostrophic wind is computed from the COSMO pressure field.
+
+    -z, --elevation, -z0 <height>: Specifies the elevation of the PALM-4U domain
+        above sea level [m]. Default: 35
+
+#### I/O
 
     -l, --hhl-file, -hhl <netCDF file>:
@@ -140 +160 @@
         Scenario path, i.e. the path of the meteorological input data. Default: ./
 
-    -r, --surface-pressure, -p0 <pressure>:
-        Manually set the pressure at z=0 in the PALM-4U domain [Pa]. If not
-        given, the surface pressure is computed from the COSMO pressure field.
-
     -s, --soil-file, -soil <netCDF file>:
         Location of the netCDF file containing the COSMO soil type map.
@@ -152 +168 @@
         to be simulated with PALM-4U. Optional parameter. Default: None
 
-    -u, --geostrophic-u, -ug <velocity>:
-        Manually specify the geostrophic wind in x direction [m/s]. If not
-        given, the geostrophic wind is computed from the COSMO pressure field.
-
-    -v, --geostrophic-v, -vg <velocity>:
-        Manually specify the geostrophic wind in y direction [m/s]. If not
-        given, the geostrophic wind is computed from the COSMO pressure field.
-
-    -z, --elevation, -z0 <height>: Specifies the elevation of the PALM-4U domain
-        above sea level [m]. Default: 35
 
 
-#### ADDITIONAL COMMAND-LINE OPTIONS
+#### FILE PREFIXES
 
     --input-prefix <prefix>:
@@ -182 +188 @@
         Set the file prefix of soil moisture input files. Default: laf
 
+#### Non-parameter options
+
     --debug:
-        Enable debugging messages.
+        Enable additional terminal messages and netCDF output for debugging.
 
     --version: