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


Ignore:
Timestamp:
Oct 30, 2018 9:40:22 AM (6 years ago)
Author:
eckhard
Comment:

Updated documentation to INIFOR version 1.4.0

Legend:

Unmodified
Added
Removed
Modified
  • doc/app/iofiles/inifor

    v3 v4  
    11= INIFOR - Mesoscale Interface for Initializing and Forcing PALM-4U =
    22
    3 INIFOR provides the meteorological fields required to initialize and drive the urban climate model PALM-4U. The required meteorological fields are interpolated from output data of the meso-scale model COSMO.
     3INIFOR provides the meteorological fields required to initialize and drive the urban-climate model PALM-4U. The required meteorological fields are interpolated from output data of the mesoscale model COSMO.
    44
    55== Compilation ==
     
    88  - Run `make`
    99
    10 == Usage ==
     10== Minimal Usage Example ==
    1111
    1212  - Customize `./namelist` (number or grid points and spacings, end_time)
    1313  - Run `current_version/trunk/SCRIPTS/inifor -path <scenario path> -date <YYYYMMDD>`
    1414
    15 == Available namelist parameters ==
     15== Usage ==
     16
     17After compilation, the `inifor` binary resides in the `$PALM_BIN` path, i.e. in `<PALM path>/current_version/trunk/SCRIPTS/`.
     18
     19In order to run, INIFOR requires three kinds of inputs:
     20
     211. hourly COSMO model output,
     222. a steering namelist file, and
     233. command-line options.
     24
     25In addition, a static driver file may be supplied (see `--static-driver` option below) in order to pass the coordinates of the PALM origin to INIFOR. If no static driver is passed to INIFOR, origin coordinates are read from the namelist file.
     26
     27A typical `inifor` call looks like this:
     28
     29{{{
     30inifor --path /data/evaluation/20170729 --date 2017073006 \
     31       --init-mode profile -n namelist -o dynamic_driver.nc \
     32       --elevation 110 --input-prefix lff0_
     33}}}
     34
     35
     36=== Input data: COSMO model output ===
     37
     38INIFOR processes COSMO model output which it requires to be stored in a set of netCDF files located in a user-specified path (see `--path` option). These are:
     39
     40- hhl.nc: This file provides the COSMO numerical grid. (''hhl'' abbreviates ''height of half layers'', i.e. the heights of the vertical cell boundaries.)
     41- soil.nc: This file provides the COSMO soil map and is used to destinguish land from water cells.
     42- `<prefix>YYYYMMDDHH-<suffix>.nc`: Each of these files contains COSMO model
     43  of one time step at the given time in UTC (Y..year, M..month, D..day, H..hour).
     44    - The `<prefix>` distinguishes different DWD products, for instance COSMO
     45      analyses (`laf`) or forecasts (`lff`).
     46    - The `<suffix>` distinguishes four kinds of COSMO model output data, namely
     47        - `flow` (atmospheric fields)
     48        - `rad` (radiation)
     49        - `soil` (soil moisture and temperature)
     50        - `soilmoisture` (precipitation and evaporation)
     51    - For example, laf2016010100-flow.nc contains the atmospheric fields of the
     52      COSMO analysis of Januray 1st, 2016 for 0:00 UTC.
     53=== Namelist parameters ===
    1654
    1755INIFOR mirrors a subset of the PALM-4U's Fortran namelists `inipar` and `d3par` and supports the following parameters:
    1856
    19 === inipar ===
     57==== inipar ====
    2058
    2159||='''Parameter name''' =||='''Default value''' =||='''Description''' =||
     
    3068
    3169
    32 === d3par ===
     70==== d3par ====
    3371
    3472||='''Parameter name''' =||='''Default value''' =||='''Description''' =||
     
    3674
    3775
    38 === Example namelist file ===
     76==== Example namelist file ====
    3977
    4078{{{
     
    5088
    5189
    52 == Available command-line options ==
     90=== Command-line options ===
     91
     92==== INIFOR configuration ====
    5393
    5494||='''Option''' =||='''Default value''' =||='''Description''' =||
    5595|-----------
    56 ||-a   ||" "  ||activation string list  ||
    57 ||-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. ||
    58 ||-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'. ||
     96|| --averaging-mode <mode> || level || Selects how averaged quantities (large-scale forcing terms) are computed. INIFOR supports averaging along input model levels ('level') and along constant heights ('height'). ||
     97|| -a, --averaging-angle <angle> || 2.0 || Width of the averaging box in longitudal and latitudal direction in the source coordinate system (COSMO rotated-pole) [deg]. ||
     98|| -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. ||
     99|| -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'. ||
     100|| -r, --surface-pressure <pressure> || 1e5 || Surface pressure at z=0 in the PALM-4U domain [Pa]. Optional parameter. ||
     101|| -u, --geostrophic-u <velocity> || 0 || Specifies the geostrophic wind in x direction [m/s]. ||
     102|| -v, --geostrophic-v <velocity> || 0 || Specifies the geostrophic wind in y direction [m/s]. ||
     103|| -z, --elevation <height> || 35 || Specifies the elevation of the PALM-4U domain above sea level [m]. ||
     104
     105==== I/O ====
    59106|| -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). ||
    60107|| -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. ||
    61108|| -o, --output <output file> || ./palm-4u-input.nc || Name of the INIFOR output file, i.e. the PALM-4U dynamic driver. ||
    62109|| -p, --path <scenario path> || ./ || Scenario path, i.e. the path of the meteorological input data. ||
    63 || -r, --surface-pressure <pressure> || 1e5 || Surface pressure at z=0 in the PALM-4U domain [Pa]. ||
    64110|| -s, --soil-file <netCDF file> || <scenario path>/soil.nc || Location of the netCDF file containing the COSMO-DE soil type map. ||
    65 || -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. ||
    66 || -u, --geostrophic-u <velocity> || 0 || Specifies the geostrophic wind in x direction [m/s]. ||
    67 || -v, --geostrophic-v <velocity> || 0 || Specifies the geostrophic wind in y direction [m/s]. ||
    68 || --version || N/A || Output version number and exit. ||
    69 || -z, --elevation <height> || 35 || Specifies the elevation of the PALM-4U domain above sea level [m]. ||
     111|| -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.
    70112
    71 
    72 == Additional command-line options ==
    73 
     113==== File prefixes ====
    74114||='''option''' =||='''default value''' =||='''description''' =||
     115|| --input-prefix <prefix> || laf || Set the file prefixes for all input files. Individual prefixes can be overwritten with the options below. ||
    75116|| --flow-prefix <prefix> || laf || Set the file prefix of flow input files. ||
    76117|| --radiation-prefix <prefix> || laf || Set the file prefix of radiation input files. ||
    77118|| --soil-prefix <prefix> || laf ||Set the file prefix of soil input files. ||
    78119|| --soilmoisture-prefix <prefix> || laf || Set the file prefix of soil moisture input files. ||
     120
     121==== Non-argument options ====
     122|| --debug || N/A || Enable additional terminal messages and netCDF output for debugging. ||
     123|| --version || N/A || Output version number and exit. ||