Actions

NCDELTA.DAT: Difference between revisions

From BAWiki

imported>Lang Guenther
(additional text added for Max_Read_Storage)
imported>Lang Guenther
(additional text added under "general remarks")
Line 2: Line 2:
|name_de=NCDELTA.DAT
|name_de=NCDELTA.DAT
|filetype=ncdelta.dat
|filetype=ncdelta.dat
|version=July 2015
|version=September 2015
|version_descr=June 2015
|version_descr=September 2015
|significance=contains general steering data for the program [[NCDELTA]].
|significance=contains general steering data for the program [[NCDELTA]].
|filecontents=
|filecontents=
Line 42: Line 42:
# Dictionary files used from directory '''''$PROGHOME/dic/''''':
# Dictionary files used from directory '''''$PROGHOME/dic/''''':
#* '''''ncdelta_dico.dat'''''.
#* '''''ncdelta_dico.dat'''''.
# Use Cases:
#* Case 1: '''Reference_File''' = simulation 1, '''Variant_File''' = simulation 2;
#* Case 2: '''Reference_File''' = measurement, '''Variant_File''' = simulation;
#* Case 3: '''Reference_File''' = measurement 1, '''Variant_File''' = measurement 2;
#: Synoptic data ''or'' data analysis results from program [[NCANALYSE]] can be used.
# General requirements:
#* Synoptic data:
#** length of time period must be identical (periods may differ), and
#** time step must be identical.
#* Analysis results ([[NCANALYSE]]):
#** length of period of data analysis must be comparable, and
#** number of events, e.g. tidal high water, must also be identical.
#* Z coordinate variables: 
#: z coordinate variables, if present, must be consistent with respect to
#:* CF attribute ''positive'' all with value "down", or
#:* CF attribute ''positive'' all with value "up"
#: (see [http://cfconventions.org/ CF metadata conventions]).
# Special requirements:
#* ref. case 1:
#** same vertical structure (number of layers), and
#** identical (tracer-) fractions (if present).
#* ref. case 2:
#** identical (tracer-) fractions (if present), and
#** measured data may contain for the same (geographical) location (x,y) several measured data in different depths (z).
#* ref. case 3:
#** each (geographical) location is allowed to be present only once; locations with several stacked data positions are not allowed currently with this use case.


|nutzerprogramme=[[NCDELTA]]
|nutzerprogramme=[[NCDELTA]]

Revision as of 09:02, 11 September 2015

Basic Information

File-Type

ncdelta.dat

File-Form

FORMATTED

Version

September 2015

Description-Date

September 2015

Significance of the File

contains general steering data for the program NCDELTA.

File-Contents (in Catchwords)

steering data

  • Block Program_Parameters: general steering data
    1. Max_Read_Storage: maximum number of data items read from input file during each analysis cycle. This value, multiplied with either 24 (REAL Single) or 48 (REAL Double), gives in good approximation NCDELTA's memory requirements (in Byte).
    2. Max_Distance: maximum distance in [m] up to which points with different location are compared.
    3. (optional) Print_Modus_Classify: parameter to steer informative printout messages in program section classification:
      1. 0 = no extensive messages printed;
      2. 1 = more extensive messages about classified variables will be printed.
    4. (optional) Print_Modus_Pairs: parameter to steer informative printout messages in program section primary partner variables:
      1. 0 = no extensive messages printed;
      2. 1 = more extensive messages about detected variable pairs will be printed;
      3. 2 = also informations about rejected variable pairs will be printed.
    5. (optional) Print_Modus_Define: parameter to steer informative printout messages in program section definition of computational results:
      1. 0 = no extensive messages printed;
      2. 1 = more extensive informations with respect to metadata of computational results will be printed.
    6. (optional) Print_Modus_Compute: parameter to steer informative printout messages in program section computation of results:
      1. 0 = no extensive messages printed;
      2. 1 = more extensive messages about computational result variables will be printed.
  • Block Data_Files: data files
    1. Reference_File: file (NETCDF) with reference data (filetype cf-netcdf.nc);
    2. Variant_File: file (NETCDF) with variant data (filetype cf-netcdf.nc);
    3. Result_File: file (NETCDF) for result data (filetype cf-netcdf.nc).
  • (optional) Block Data_Operations: data operations
    1. (optional) With_Ordinary_Differences: compute (.true.) common differences (if possible) or do not compute (.false.);
    2. (optional) With_Taylor_Diagram_Data: compute (.true.) data for Taylor diagram (if possible) or do not compute (.false.);
    3. (optional) With_Median: compute (.true.) median (>= 32 events) or do not compute (.false.);
    4. (optional) With_Percentiles_05_95: compute (.true.) percentiles Q05, Q95 (>= 32 events) or do not compute (.false.);
    5. (optional) With_Percentiles_01_99: compute (.true.) percentiles Q01, Q99 (>= 51 events) or do not compute (.false.).
  • (optional) Block Exclude_Variable_From_NCDELTA: list of variables to be excluded from computation.
    1. Variant_Variable: variable from Variant-File. Key can be prescribed several times. With exception of the variables listed here results will be computed for all primary variable pairs.
  • (optional) Block Include_Only_Variable_for_NCDELTA: list of variables for which results ar exclusively computed.
    1. Variant_Variable: variable from Variant-File. Key can be prescribed several times. Results will be solely computed for the variables listed here.

General Remarks

  1. Dictionary files used from directory $PROGHOME/dic/:
    • ncdelta_dico.dat.
  2. Use Cases:
    • Case 1: Reference_File = simulation 1, Variant_File = simulation 2;
    • Case 2: Reference_File = measurement, Variant_File = simulation;
    • Case 3: Reference_File = measurement 1, Variant_File = measurement 2;
    Synoptic data or data analysis results from program NCANALYSE can be used.
  3. General requirements:
    • Synoptic data:
      • length of time period must be identical (periods may differ), and
      • time step must be identical.
    • Analysis results (NCANALYSE):
      • length of period of data analysis must be comparable, and
      • number of events, e.g. tidal high water, must also be identical.
    • Z coordinate variables:
    z coordinate variables, if present, must be consistent with respect to
    • CF attribute positive all with value "down", or
    • CF attribute positive all with value "up"
    (see CF metadata conventions).
  4. Special requirements:
    • ref. case 1:
      • same vertical structure (number of layers), and
      • identical (tracer-) fractions (if present).
    • ref. case 2:
      • identical (tracer-) fractions (if present), and
      • measured data may contain for the same (geographical) location (x,y) several measured data in different depths (z).
    • ref. case 3:
      • each (geographical) location is allowed to be present only once; locations with several stacked data positions are not allowed currently with this use case.

Programs using this Type of File

NCDELTA

Example-File

$PROGHOME/examples/ncdelta/ncdelta.dat


back to: File Descriptions


Overview