DATACONVERT: Difference between revisions

Latest revision as of 08:50, 6 September 2022

Basic Information

Name of Program

DATACONVERT

Version-Date

August 2020

Description-Date

September 2022

Catchwords

conversion of Delft3D computational grid
conversion of Delft3D computational results
conversion of (DWD) NetCDF data files
merge of (DWD) NetCDF data files in one NetCDF file
conversion of BDF data into CF NetCDF data
conversion of meteorological data into the Delft3D format METEO_DLFT
conversion of timeseries in BOEWRT format into CF NetCDF data (with optional status flag variable)
conversion of CF SGRID NetCDF into CF UGRID NetCDF

Acknowledgment: This project took advantage of netCDF software developed by UCAR/Unidata (www.unidata.ucar.edu/software/netcdf/).

Short Description of Functionality

Program DATACONVERT is used to convert computational results and data:

mode 1: conversion of computational results from the integrated modelling system Delft3D into BAW-specific data formats, with
- conversion of a Delft3D computational grid into UnTRIM grid format,
- conversion of two-dimensional (depth averaged) Delft3D computational results into BDF data format (2D),
- conversion and depth averaging of three-dimensional Delft3D computational results into BDF data format (2D), and
- conversion of three-dimensional Delft3D computational results (sigma-coordinates) into BDF data format (3D, z-layers).

Dynamic model bathymetry (morphodynamics) is supported for 2D as well as 3D computational results. If Delft3D model results have been produced for a domain decomposition run, the converted results are written to different domain-specific data files and are not yet combined into one single file.

A conversion into the subsequent physical output quantities is currently possible:

water level,
current velocity,
salinity,
temperature,
bathymetry (static),
transient bathymetric depth,
vertical erosion,
suspended load (icode=7),
new: (mass) bed load transport rate (icode=621), converted from a volume transport rate,
new: (mass) suspended load transport rate (icode=622), converted from a volume transport rate and
new: bottom shear stress

mode 2: conversion of (DWD) NetCDF data files into BAW-specific data formats, with
- generation of a grid from data points defined in the NetCDF data file, and
- conversion of NetCDF data into BAWs BDF file format.
mode 3: merge contents of several (DWD) NetCDF data files into a single NetCDF data file, with
- transfer of meta data as well as data for identical dates into a single NetCDF data file.
mode 4: conversion of BDF data into cf-netcdf.nc data, for
mode 6: conversion of meteorological data into Delft3D format METEO_DLFT.
mode 7: conversion of timeseries and meta information in BOEWRT format into cf-netcdf.nc data according to NODC's feature type template for timeSeries. Creation of optional status flag variable for description of data quality is supported.
mode 8: conversion of CF SGRID NetCDF into CF UGRID NetCDF (see cf-netcdf.nc).

Input-Files

steering data
file of type dataconvert.dat. The extended description for this file contains comprehensive informations with respect to steering data, input as well as output data files.
computational grid
- mode 1
  - delft3d.grd,
  - delft3d.dep, and
  - delft3d.enc.
  - (optional) delft3d.dry,
  - (optional) delft3d.thd,
  - (optional) delft3d.lwl,
  - (optional) delft3d.ext, as well as
  - (optional) delft3d.bnd.
- mode 2 - no grid file required
- mode 3 - no grid file required
- mode 4
  - location_grid.dat or cf-netcdf.nc (from GRIDCONVERT).
  - gitter05.dat and gitter05.bin or cf-netcdf.nc (from GRIDCONVERT).
  - untrim_grid.dat or cf-netcdf.nc (from GRIDCONVERT).
  - utrsub_grid.dat (only with false subgrid - one subpolygon/polygon, one subedge/edge).
  - profil05.bin or cf-netcdf.nc (from GRIDCONVERT).
- mode 6
  - all grid file formats used with BDF data, e. g. gitter05.dat and gitter05.bin.
- mode 7 - no grid file required
- mode 8 - no grid file required
(optional) global metadata
- Setting metadata via shell scripts, envrionment variables can of a simulation can be set in a run script. Variables describing the project can be stored in a project script (German: Auftragsskript) under $PROGHOME/bin/dmqs. So, DMQS compliant metadata is generated.
- nc_meta.dat, in case file nc_meta.dat is present in the current working directory, this file will be read by the application. Otherwise the respective file from $PROGHOME/cfg will be read.
computational results or data
- mode 1
  - netcdf.cdf.
- mode 2
  - netcdf.cdf.
- mode 3
  - netcdf.cdf.
- mode 4
  - BDF data files dirz.bin, dirz.bin.I and dirz.bin.R
- mode 6
  - meteorological BDF files dirz.bin, dirz.bin.I and dirz.bin.R.
- mode 7
  - time series in boewrt.dat.
- mode 8
  - netcdf.cdf (CF SGRID NetCDF).
(optional) vertical structure
- mode 1
  - vertical.dat.
- mode 2 - no vertical structure required
- mode 3 - no vertical structure required
- mode 4 - no vertical structure required
- mode 6 - no vertical structure required
- mode 7 - no vertical structure required
- mode 8 - no vertical structure required

Output-Files

converted computational grid
- mode 1
  - untrim_grid.dat.
- mode 2
  - gitter05.dat/bin
- mode 3 - no grid generated
- mode 4
  - (optional) cf-netcdf.nc
- mode 6
  - implicit regular grid
- mode 7 - no grid generated
- mode 8 - no grid generated
converted computational results
- mode 1
  - dirz.bin.r,
  - dirz.bin.i, and
  - dirz.bin.
- mode 2
  - dirz.bin.r,
  - dirz.bin.i, and
  - dirz.bin.
- mode 3
  - netcdf.cdf.
- mode 4
  - cf-netcdf.nc,
- mode 6
  - METEO_DLFT
- mode 7
  - cf-netcdf.nc.
- mode 8
  - cf-netcdf.nc (CF UGRID NetCDF).
printer file
- dataconvert.sdr.
(optional) trace file
- dataconvert.trc.

Methodology

The original computational grid is in case converted using methods from software package H_GRID or L_GRID. Interpolation of computational results is performed using methods from the H_IP package. Read and Write of computational data is carried through essentially using methods from software package IO_DATASET and in mode 6 also using IO_DELFT.

Program(s) to run before this Program

DELFT3D, GETDATA, GRIDCONVERT, UNTRIM2007, UNTRIM2, XTRLQ2.

Program(s) to run after this Program

ABDF, ADCP2PROFILE, ArcGIS-Applications, DAVIT, DELFT3D, DIDAMERGE, DIDARENAME, DIDASPLIT, ENERF, GVIEW2D, HVIEW2D, IO_VOLUME, METDIDA, NCANALYSE, NCAUTO, NCCHUNKIE, NCDELTA, NCDVAR, NCMERGE, NCPLOT, NCRCATMAT, NC2TABLE, NCVIEW2D, NetCDF Operators, PARTRACE, PGCALC, PLOTPROFILZEIT, PLOTTS, QUICKPLOT, UNK, UNS, VTDK, XTRDATA, XTRLQ2, ZEITR.

Additional Information

Language

Fortran90

Additional software

-

Original Version

G. Lang, P. Schade

Maintenance

Arbeitsgruppe POS

Documentation/Literature

for example input files please refer to $PROGHOME/examples/dataconvert/

back to Program Descriptions

Overview

@@ Line 2: / Line 2: @@
 |name_de=DATACONVERT
 |name=DATACONVERT
-|version=6.x / October 2007
+|version=August 2020
-|version_descr=October 2007
+|version_descr=September 2022
 |catchwords=conversion of Delft3D computational grid<br />
-conversion of Delft3D computational results
+conversion of Delft3D computational results<br />
-|shortdescription=Program DATACONVERT is used to convert computational results from the integrated modelling system Delft3D into BAW-specific data formats. The following conversions are currently supported:
+conversion of (DWD) NetCDF data files<br />
-: conversion of a Delft3D computational grid into UnTRIM grid format,
+merge of (DWD) NetCDF data files in one NetCDF file<br />
-: conversion of two-dimensional (depth averaged) Delft3D computational results into BDF data format (2D),
+conversion of BDF data into CF NetCDF data <br />
-: conversion and depth averaging of three-dimensional Delft3D computational results into BDF data format (2D), and
+conversion of meteorological data into the Delft3D format METEO_DLFT <br />
-: conversion of three-dimensional Delft3D computational results (sigma-coordinates) into BDF data format (3D, z-layers).
+conversion of timeseries in BOEWRT format into CF NetCDF data (with optional [[BOEWRT.DAT#Status-Flag_Variable|status flag variable]])<br />
+conversion of CF SGRID NetCDF into CF UGRID NetCDF<br />
-Dynamic model bathymetry (morphodynamics) is supported for 2D as well as 3D computational results. If Delft3D model results have been produced for a domain decomposition run, the converted results are written to different domain-specific data files and are not yet combined into one single file.
+ Acknowledgment: ''This project took advantage of netCDF software developed by UCAR/Unidata ([http://www.unidata.ucar.edu/software/netcdf/ www.unidata.ucar.edu/software/netcdf/]).''
-Conversion of subsequent physical quantities is currently possible:
+|shortdescription=Program DATACONVERT is used to convert computational results and data:
+* '''mode 1''': conversion of computational results from the integrated modelling system Delft3D into BAW-specific data formats, with<br />
+** conversion of a Delft3D computational grid into UnTRIM grid format,
+** conversion of two-dimensional (depth averaged) Delft3D computational results into BDF data format (2D),
+** conversion and depth averaging of three-dimensional Delft3D computational results into BDF data format (2D), and
+** conversion of three-dimensional Delft3D computational results (sigma-coordinates) into BDF data format (3D, z-layers).<br />
+Dynamic model bathymetry (morphodynamics) is supported for 2D as well as 3D computational results. If Delft3D model results have been produced for a domain decomposition run, the converted results are written to different domain-specific data files and are not yet combined into one single file.<br /><br />
+A conversion into the subsequent physical output quantities is currently possible:
 # water level,
 # current velocity,
 # salinity,
 # temperature,
-# suspended sediment (several fractions),
 # bathymetry (static),
-# transient bathymetric depth, and
+# transient bathymetric depth,
-# vertical erosion.
+# vertical erosion,
+# suspended load (icode=7),
+# ''new'': (mass) bed load transport rate (icode=621), converted from a volume transport rate,
+# ''new'': (mass) suspended load transport rate (icode=622), converted from a volume transport rate and
+# ''new'': bottom shear stress
+* '''mode 2''': conversion of (DWD) NetCDF data files into BAW-specific data formats, with
+** generation of a grid from data points defined in the NetCDF data file, and
+** conversion of NetCDF data into BAWs BDF file format.<br />
+* '''mode 3''': merge contents of several (DWD) NetCDF data files into a single NetCDF data file, with
+** transfer of meta data as well as data for identical dates into a single NetCDF data file.
+* '''mode 4''': conversion of [[DIRZ.BIN|BDF]] data into [[CF-NETCDF.NC|cf-netcdf.nc]] data, for
+** [[NetCDF synoptic data at multiple locations|synoptic data at multiple locations]].
+** [[NetCDF synoptic data for triangular grid|synoptic data for triangular grid]].
+** [[NetCDF synoptic (morphological) data for triangular grid|synoptic (morphological) data for triangular grid]].
+** [[NetCDF synoptic data for unstructured grid|synoptic data for unstructured grid]].
+** [[NetCDF synoptic data for multiple profiles|synoptic data for multiple profiles]].
+* '''mode 6''': conversion of meteorological data into Delft3D format METEO_DLFT.
+* '''mode 7''': conversion of timeseries and meta information in [[BOEWRT.DAT|BOEWRT format]] into [[CF-NETCDF.NC|cf-netcdf.nc]] data according to NODC's [http://www.nodc.noaa.gov/data/formats/netcdf/#templatesexamples feature type template for timeSeries]. Creation of optional [[BOEWRT.DAT#Status-Flag_Variable|status flag variable]] for description of data quality is supported.
+* '''mode 8''': conversion of CF SGRID NetCDF into CF UGRID NetCDF (see [[CF-NETCDF.NC|cf-netcdf.nc]]).
 |inputfiles=
-# steering data
+# '''steering data'''
-#: file of type dataconvert.dat. The extended description for this file contains comprehensive informations with respect to steering data, input as well as output data files.
+#: file of type [[DATACONVERT.DAT|dataconvert.dat]]. The extended description for this file contains comprehensive informations with respect to steering data, input as well as output data files.
-# computational grid
+# '''computational grid'''
-#:required:
+#* '''mode 1'''
-#:[[DELFT3D.GRD|delft3d.grd]],
+#**[[DELFT3D.GRD|delft3d.grd]],
-#:[[DELFT3D.DEP|delft3d.dep]], and
+#**[[DELFT3D.DEP|delft3d.dep]], and
-#:[[DELFT3D.ENC|delft3d.enc]].
+#**[[DELFT3D.ENC|delft3d.enc]].
-#: optional:
+#**(optional) [[DELFT3D.DRY|delft3d.dry]],
-#:* [[DELFT3D.DRY|delft3d.dry]],
+#**(optional) [[DELFT3D.THD|delft3d.thd]],
-#:* [[DELFT3D.THD|delft3d.thd]],
+#**(optional) [[DELFT3D.LWL|delft3d.lwl]],
-#:* [[DELFT3.LWL|delft3d.lwl]],
+#**(optional) [[DELFT3D.EXT|delft3d.ext]], as well as
-#:* [[DELFT3D.EXT|delft3d.ext]], as well as
+#**(optional) [[DELFT3D.BND|delft3d.bnd]].
-#:* [[DELFT3D.BND|delft3d.bnd]].
+#* '''mode 2''' - no grid file required
+#* '''mode 3''' - no grid file required
-computational results
+#* '''mode 4'''
-:* [[NETCDF.CDF|netcdf.cdf.]]
+#** [[LOCATION_GRID.DAT|location_grid.dat]] or [[CF-NETCDF.NC|cf-netcdf.nc]] (from [[GRIDCONVERT]]).
+#** [[GITTER05.DAT and GITTER05.BIN|gitter05.dat and gitter05.bin]] or [[CF-NETCDF.NC|cf-netcdf.nc]] (from [[GRIDCONVERT]]).
-(optional) vertical structure
+#** [[UNTRIM_GRID.DAT|untrim_grid.dat]] or [[CF-NETCDF.NC|cf-netcdf.nc]] (from [[GRIDCONVERT]]).
-:* [[ VERTICAL.DAT|vertical.dat.]]
+#** [[UTRSUB_GRID.DAT|utrsub_grid.dat]] (only with ''false'' subgrid - one subpolygon/polygon, one subedge/edge).
+#** [[PROFIL05.BIN|profil05.bin]] or [[CF-NETCDF.NC|cf-netcdf.nc]] (from [[GRIDCONVERT]]).
+#* ''' mode 6'''
+#** all grid file formats used with BDF data, e. g. [[GITTER05.DAT and GITTER05.BIN|gitter05.dat and gitter05.bin]].
+#* '''mode 7''' - no grid file required
+#* '''mode 8''' - no grid file required
+# '''(optional) global metadata'''
+#* [[Metadata_of_Model_results_in_Coastal_Engineering|Setting metadata via shell scripts]], envrionment variables can of a simulation can be set in a run script. Variables describing the project can be stored in a project script (German: Auftragsskript) under $PROGHOME/bin/dmqs. So, DMQS compliant metadata is generated.
+#* [[NC_META.DAT|nc_meta.dat]], in case file ''nc_meta.dat'' is present in the current working directory, this file will be read by the application. Otherwise the respective file from $PROGHOME/cfg will be read.
+# '''computational results or data'''
+#* '''mode 1'''
+#** [[NETCDF.CDF|netcdf.cdf.]]
+#* '''mode 2'''
+#** [[NETCDF.CDF|netcdf.cdf.]]
+#* '''mode 3'''
+#** [[NETCDF.CDF|netcdf.cdf.]]
+#* ''' mode 4'''
+#** BDF data files [[DIRZ.BIN|dirz.bin]], [[DIRZ.BIN.I|dirz.bin.I]] and [[DIRZ.BIN.R|dirz.bin.R]]
+#* '''mode 6'''
+#** meteorological BDF files [[DIRZ.BIN|dirz.bin]], [[DIRZ.BIN.I|dirz.bin.I]] and [[DIRZ.BIN.R|dirz.bin.R]].
+#* '''mode 7'''
+#**time series in [[BOEWRT.DAT|boewrt.dat]].
+#* '''mode 8'''
+#** [[NETCDF.CDF|netcdf.cdf]] (CF SGRID NetCDF).
+#(optional) '''vertical structure'''
+#* '''mode 1'''
+#** [[ VERTICAL.DAT|vertical.dat.]]
+#* '''mode 2''' - no vertical structure required
+#* '''mode 3''' - no vertical structure required
+#* '''mode 4''' - no vertical structure required
+#* '''mode 6''' - no vertical structure required
+#* '''mode 7''' - no vertical structure required
+#* '''mode 8''' - no vertical structure required
 |outputfiles=
-# converted computational grid
+# '''converted computational grid'''
-#:* [[UNTRIM_GRID.DAT|untrim_grid.dat.]]
+#* '''mode 1'''
-# converted computational results
+#** [[UNTRIM_GRID.DAT|untrim_grid.dat.]]
-#:* [[DIRZ.BIN.R|dirz.bin.r]],
+#* '''mode 2'''
-#:* [[DIRZ.BIN.I|dirz.bin.i]], and
+#** [[GITTER05.DAT and GITTER05.BIN|gitter05.dat/bin]]
-#:* [[DIRZ.BIN|dirz.bin.]]
+#* '''mode 3''' - no grid generated
-# printer file
+#* '''mode 4'''
-#:* [[DATACONVERT.SDR|dataconvert.sdr.]]
+#** (optional) [[CF-NETCDF.NC|cf-netcdf.nc]]
-# (optional) trace file
+#* '''mode 6'''
-#:* [[DATATCONVERT.TRC|dataconvert.trc.]]
+#** implicit regular grid
-|methodology=The original computational grid is converted using methods from software package H_GRID. Conversion of computational results is performed using methods from the H_IP package. Read and Write of computational data is carried through using several methods from software package IO_DATASET.
+#* '''mode 7''' - no grid generated
-|preprocessor=[[DELFT3D]], [[GETDATA]].
+#* '''mode 8''' - no grid generated
-|postprocessor=[[ABDF]], [[ADCP2PROFILE]], [[DIDAMERGE]], [[DIDARENAME]], [[DIDASPLIT]], [[ENERF]], [[GVIEW2D]], [[HVIEW2D]], [[IO_VOLUME]], [[PARTRACE]], [[PARTRACE-3D]], [[PGCALC]], [[UNK]], [[UNS]], [[VTDK]], [[XTRDATA]], [[XTRLQ2]], [[ZEITR.]]
+# '''converted computational results'''
+#* '''mode 1'''
+#** [[DIRZ.BIN.R|dirz.bin.r]],
+#** [[DIRZ.BIN.I|dirz.bin.i]], and
+#** [[DIRZ.BIN|dirz.bin.]]
+#* '''mode 2'''
+#** [[DIRZ.BIN.R|dirz.bin.r]],
+#** [[DIRZ.BIN.I|dirz.bin.i]], and
+#** [[DIRZ.BIN|dirz.bin.]]
+#* '''mode 3'''
+#** [[NETCDF.CDF|netcdf.cdf]].
+#* '''mode 4'''
+#** [[CF-NETCDF.NC|cf-netcdf.nc]],
+#* '''mode 6'''
+#** [[METEO_DLFT]]
+#* '''mode 7'''
+#** [[CF-NETCDF.NC|cf-netcdf.nc]].
+#* '''mode 8'''
+#** [[CF-NETCDF.NC|cf-netcdf.nc]] (CF UGRID NetCDF).
+# '''printer file'''
+#* dataconvert.sdr.
+# (optional) '''trace file'''
+#* dataconvert.trc.
+|methodology=The original computational grid is in case converted using methods from software package H_GRID or L_GRID. Interpolation of computational results is performed using methods from the H_IP package. Read and Write of computational data is carried through essentially using methods from software package IO_DATASET and in mode 6 also using IO_DELFT.
+|preprocessor=[http://www.baw.de/methoden/index.php5/Mathematisches_Verfahren_DELFT3D DELFT3D], [[GETDATA]], [[GRIDCONVERT]], [[UNTRIM2007]], [[UNTRIM2]], [[XTRLQ2]].
+|postprocessor=[[ABDF]], [[ADCP2PROFILE]], [[ArcGIS-Applications]], [[DAVIT]], [[Mathematical_Model_DELFT3D|DELFT3D]], [[DIDAMERGE]], [[DIDARENAME]], [[DIDASPLIT]], [[ENERF]], [[GVIEW2D]], [[HVIEW2D]], [[IO_VOLUME]], [[METDIDA]], [[NCANALYSE]], [[NCAUTO]], [[NCCHUNKIE]], [[NCDELTA]], [[NCDVAR]], [[NCMERGE]], [[NCPLOT]], [[NCRCATMAT]], [[NC2TABLE]], [[NCVIEW2D]], [[NetCDF Operators]], [[PARTRACE]], [[PGCALC]], [[PLOTPROFILZEIT]], [[PLOTTS]], [[QUICKPLOT]], [[UNK]], [[UNS]], [[VTDK]], [[XTRDATA]], [[XTRLQ2]], [[ZEITR]].
 |language=Fortran90
 |add_software=-
-|contact_original=[mailto:günther.lang@baw.de G. Lang]
+|contact_original=G. Lang, P. Schade
-|contact_maintenance=[mailto:günther.lang@baw.de G. Lang,], [mailto:susanne.spohr@baw.de S. Spohr,]
+|contact_maintenance=[mailto:pos.proghome@baw.de Arbeitsgruppe POS]
-|documentation=for example input files please refer to '''$PROGHOME/examples/dataconvert/'''
+|documentation=for example input files please refer to $PROGHOME/examples/dataconvert/
 }}