Actions

NCDVAR.DAT: Difference between revisions

From BAWiki

(page formatting improved)
mNo edit summary
 
(2 intermediate revisions by 2 users not shown)
Line 2: Line 2:
|name_de=NCDVAR.DAT
|name_de=NCDVAR.DAT
|filetype=ncdvar.dat
|filetype=ncdvar.dat
|version=April 2020
|version=May 2023
|version_descr=April 2020
|version_descr=April 2020
|significance=contains general steering data for the program [[NCDVAR]].
|significance=contains general steering data for the program [[NCDVAR]].
Line 9: Line 9:


* Block '''Program_Parameters''': Allgemeine Steuerdaten
* Block '''Program_Parameters''': Allgemeine Steuerdaten
*# '''Max_Read_Storage''': Different number of data values that can be read for each input variable in a copy cycle.
*# '''Max_Read_Storage''': Maximum number of data values ​​that can be read for each input variable in a copy cycle. Default = 125000000.
*# (optional) '''Create_Missing_Variables'''
*# (optional) '''Create_Missing_Variables''': Generate additional variables
*# (optional) '''NC_Deflate_Level'''
*#* 0 = do not create additional variables (default)
*# (optional) '''END_After_Define'''
*#* 1 = generate additional variables (in combination with DFlow FM)
*# (optional) '''Delete_Coordinate_Variables'''
*# (optional) '''NC_Deflate_Level''': Compression of the result data
*# (optional) '''Chunk_Output_File'''
*#* 0 = no compression
*#* 1 ... 8 = compression (default = 3)
*#* 9 = maximum compression
*# (optional) '''END_After_Define''': Abort after generating the metadata of the output file
*#* .false. = Program runs through to the end (default)
*#* .true. = Program ends after definition of the result file (metadata)
*# (optional) '''Delete_Coordinate_Variables''': Delete coordinate variables of a certain type
*#* X-Y = all x and y coordinate variables (projected coordinates) are not transferred
*#* LON-LAT = all lon and lat coordinates (geographic coordinates) are not transferred
*#* If this key is not specified, all coordinate variables are transferred
* Block '''Input_File''': Input-Datei
* Block '''Input_File''': Input-Datei
*# '''Data_File''': Name and type of the input file (file of type [[CF-NETCDF.NC|netcdf.nc]])
*# '''Data_File''': Name and type of the input file (file of type [[CF-NETCDF.NC|netcdf.nc]])
Line 21: Line 30:
*# '''Data_File''' Name and type of the output file (file of type [[CF-NETCDF.NC|netcdf.nc]])
*# '''Data_File''' Name and type of the output file (file of type [[CF-NETCDF.NC|netcdf.nc]])
:::- File cannot exist
:::- File cannot exist
* (optional) Block '''Mesh_Variables_Action''': Actions on all variables of a grid (''Mesh'')
* (optional) Block '''Mesh_Variables_Action''': Actions on all variables of a grid (mesh)
*# '''Action''': Name of ''Mesh''-Variable and action (''COPY'', ''DELETE''), to be executed on the variables of this grid.
*# '''Action''' Name of the mesh variable and action ('''COPY''', '''DELETE''') to be carried out on the variables of this grid
:::- Not all [[CF-NETCDF.NC|netcdf.nc]] files contain ''Mesh'' variables;
:::- Not all netcdf.nc files have mesh variables;
:::- Line can be specified more than once.
:::- If '''ALL''' is specified for Mesh, all variables are set to the corresponding action;
:::- The line may be specified more than once.
* (optional) Block '''Single_Variable_Action''': Actions for individual variables
* (optional) Block '''Single_Variable_Action''': Actions for individual variables
*# '''Action''': Name of ''Variable'' and action (''COPY'', ''DELETE''), which should be carried out for this variable.  
*# '''Action''': Name of the variable and action ('''COPY''', '''DELETE''') to be carried out for this variable.
:::- Line can be specified more than once;
:::- Line may be specified more than once;
:::- Overrides the global ''Action'' in block '''Mesh_Variables_Action'''.  
:::- Overrides the global action in Block '''Mesh_Variables_Action''';
:::- The user may only list variables that he can ''influence''. These are also known as ''geophysical variables''. Coordinate variables, measure variables, etc. must not be specified by the user.
* (optional) Block '''Time_Coordinate_Thinning''': Thinning out of equidistant time coordinates
* (optional) Block '''Time_Coordinate_Thinning''': Thinning out of equidistant time coordinates
*# '''Time_KV_Name''': Name of a time coordinate variable
*# '''Time_KV_Name''': Name of a time coordinate variable

Latest revision as of 10:11, 17 May 2023

Basic Information

File-Type

ncdvar.dat

File-Form

FORMATTED

Version

May 2023

Description-Date

April 2020

Significance of the File

contains general steering data for the program NCDVAR.

File-Contents (in Catchwords)

steering data

  • Block Program_Parameters: Allgemeine Steuerdaten
    1. Max_Read_Storage: Maximum number of data values ​​that can be read for each input variable in a copy cycle. Default = 125000000.
    2. (optional) Create_Missing_Variables: Generate additional variables
      • 0 = do not create additional variables (default)
      • 1 = generate additional variables (in combination with DFlow FM)
    3. (optional) NC_Deflate_Level: Compression of the result data
      • 0 = no compression
      • 1 ... 8 = compression (default = 3)
      • 9 = maximum compression
    4. (optional) END_After_Define: Abort after generating the metadata of the output file
      • .false. = Program runs through to the end (default)
      • .true. = Program ends after definition of the result file (metadata)
    5. (optional) Delete_Coordinate_Variables: Delete coordinate variables of a certain type
      • X-Y = all x and y coordinate variables (projected coordinates) are not transferred
      • LON-LAT = all lon and lat coordinates (geographic coordinates) are not transferred
      • If this key is not specified, all coordinate variables are transferred
  • Block Input_File: Input-Datei
    1. Data_File: Name and type of the input file (file of type netcdf.nc)
- File must exist
  • Block Output_File: Output-Datei
    1. Data_File Name and type of the output file (file of type netcdf.nc)
- File cannot exist
  • (optional) Block Mesh_Variables_Action: Actions on all variables of a grid (mesh)
    1. Action Name of the mesh variable and action (COPY, DELETE) to be carried out on the variables of this grid
- Not all netcdf.nc files have mesh variables;
- If ALL is specified for Mesh, all variables are set to the corresponding action;
- The line may be specified more than once.
  • (optional) Block Single_Variable_Action: Actions for individual variables
    1. Action: Name of the variable and action (COPY, DELETE) to be carried out for this variable.
- Line may be specified more than once;
- Overrides the global action in Block Mesh_Variables_Action;
- The user may only list variables that he can influence. These are also known as geophysical variables. Coordinate variables, measure variables, etc. must not be specified by the user.
  • (optional) Block Time_Coordinate_Thinning: Thinning out of equidistant time coordinates
    1. Time_KV_Name: Name of a time coordinate variable
    2. Start_Time: Start time and time zone in format DD.MM.YYYY-hh:mm:ss.nnnnnnnnn zone
    3. End_Time: End time and time zone in format DD.MM.YYYY-hh:mm:ss.nnnnnnnnn zone
    4. Time_Step: Time step in format dddddd-hh:mm:ss.nnnnnnnnn
- Only works for temporally equidistant input data;
- The start and end times must be present in the input data;
- The time step must be an integer multiple of the input data.

General Remarks

  1. Used dictionary files from directory $PROGHOME/dic/:
    • ncdvar_dico.dat.
  2. Applications:
    • Case 1: deleting coordinate variables of a certain type;
    • Case 2: deleting/copying variables present on a certain grid;
    • Case 3: deleting/copying selected variables;
    • Case 4: deleting/copying selected dates in the time direction of equidistant data.

Programs using this Type of File

NCDVAR

Example-File

$PROGHOME/examples/ncdvar/ncdvar.dat


back to: File Descriptions


Overview