BAWiki - User contributions [en]

NCVIEW2D

2021-03-19T07:47:45Z

Ak3rhage:

{{ProgramDescription
|name_de=NCVIEW2D
|name=NCVIEW2D
|version=March 2021
|version_descr=March 2021
|catchwords=oostprozessor 
time series 
[[CF-NETCDF.NC|cf-netcdf.nc]]

|shortdescription=
[[NCVIEW2D]] is applied to visualize [[CF-NETCDF.NC|cf-netcdf.nc]] data as time series. The following objects are within a plot:

# plot window(s) (also subplots)
# y-axis
# data

A plot window can also have two y-axis with 5 individual data sets each. E. g. plot window 1 and its y-axis 1 can contain the measured and modeled water level, while plot window 2 could show measured salinity on the left y-axis and discharge on the right y-axis.
Plot windows are placed from north to south. Below the lowes window, the UUID of the [[CF-NETCDF.NC|cf-netcdf.nc]] data may be displayed as legend.

<gallery>
Time series.example 1.de.png|example 1
Time series.example 2.en.png|example 2
Time series.example 3.en.png|example 3
</gallery>

|Remarks=
# Variable names can be obtained via ncdump -h myData.nc
# Measurements from [[BOEWRT]] can be converted to [[CF-NETCDF.NC|cf-netcdf.nc]] using [[DATACONVERT]] or [[BOE2NC]]
# Only the last y-label/y-limit of a figure and an axis is used for visualization
# The maximum number of plot windows is 3.
# This project took advantage of netCDF software developed by UCAR/Unidata ([http://www.unidata.ucar.edu/software/netcdf/ Link]).

|inputfiles=
# req: [[NCVIEW2D.DAT]]

|outputfiles=
# [[MATLAB]] figure *.fig
# [[DMQS]] metadata (stored in figure)
# program log *.sdr
# errors and warning *.err
# opt: plot data stored as spreadsheet or [https://de.mathworks.com/help/matlab/timetables.html MATLAB Timetable]
# opt: other formats such as *.jpg, *.tif, *.svg, *.pdf, *.png

|methodology=
This program was written in [[MATLAB]] and takes advantage of existing PROGHOME methods, such as unit conversion or i/o of [[BOEWRT]] data. The program is subdivided in the following sections:

# Reading and checking the steering file
# Testing of the existence of input data and its variables
# Testing of the plausibility of input parameters
# Extracting optional parameters, which have been given in [[NCVIEW2D.DAT]], other data is set to a default value.
# Data import (file, variables)
# opt: data operations
# opt: data smoothing
# Testing of existence of x-axis limits
# Initialising the figure environment
# Initialising the the axis
# Initialising the the legend
# Initialising the UUID legend (if requested)
# Initialising the figure title (if requested)
# Initialising the figure box and grid lines (if requested)
# Initialising the textboxes (if requested)
# Writing [[DMQS]] information in *.fig
# Export *.fig
# opt: export further formats (if requested)
# opt: export of data as spreadsheet (xlsx) or [https://de.mathworks.com/help/matlab/timetables.html MATLAB Timetable]
# controlled end

|preprocessor=[[UNTRIM]], [[UNTRIM2]], [[UNK]], [[DATACONVERT]], [[BOE2NC]], [[NCDELTA]], [[NCANALYSE]], [[NCCUTOUT]], [https://www.deltares.nl/en/software/delft3d-flexible-mesh-suite/ Delft3D-Flexible Mesh]
|postprocessor=[[MATLAB]]
|language=MATLAB r2020b
|add_software= keine
|contact_original=[mailto:robert.hagen@baw.de R. Hagen]
|contact_maintenance=[mailto:robert.hagen@baw.de R. Hagen], [mailto:ulrike.schiller@baw.de U. Schiller]

|documentation=
* Template Files:
** template files available in '''$PROGHOME/examples/ncdelta'''
}}

NCPOLO

2020-04-16T10:21:01Z

Ak3rhage:

{{ProgramDescription
|name_de=NCPOLO
|name=NCPOLO
|version=August 2019
|version_descr=April 2020
|catchwords=Postprocessor 
time series 
hodograph 
scatterplots 
model skill

|shortdescription=
[[NCPOLO]] is applied in model calibration and validation. It corroborates validation illustration and skill scores combined with various export possibilities. With [[NCPOLO]], a observation-prediction comparison can be performed quickly. For a successful application of [[NCPOLO]], all measurements and model data must be available in pooled [[CF-NETCDF.NC|cf-netcdf.nc]] data. A time and space correlated difference, which can be interpreted by [[NCPOLO]] must be created with [[NCDELTA]].

Remarks:
* One should use [[BOE2NC]] for the preprocessing of non-pooled [[BOEWRT.DAT]] data
* Measurements should be checked, as [[NCPOLO]] does not perform any plausibility checks on input data
* Measurement names must be one-of-a-kind, as more than one measurement (e. g. multiple depths) are not possible to interpret yet.
* Stations are named from the long_name of the [[NCDELTA]] variant
* Model data can be provided in 2d and 3d
* [[NCDELTA]] '''must''' be run with ''with_original_data = .true.''
* The station name will be used troughout illustrations and skill scores. Thus it is smart to chose a short name.
* The processing of chunked data is usually faster, when using [[NCDELTA]]. One can chunk a [[CF-NETCDF.NC|cf-netcdf.nc]] file using [[NCCHUNKIE]].
* As the output can be defined in multiple languages, with more than 5 detailed times per tide gauge, the output mass can grow quickly to more than 1,000. Therefore, a user should only enable the illustrations, which are absolutely required.

Output of [[NCPOLO]]:
* time series (complete, parts)
* scatter plots (colored by density, uniform)
* hodographs of current (colored by density, uniform)
* box-whisker error distribution
* statistics (33 parameters)
* data export (per gauge)
* statistics export (per gauge, all gauges)

|inputfiles=
* req: steering[[NCPOLO.DAT]]

|outputfiles=
* (req) log (type *.sdr)
* (req) errors and warnings (type *.err)
* (req) time series (type PNG, FIG, EPS, FIG)
* (opt) scatter plot (type PNG, FIG, EPS, FIG)
* (opt) hodograph (type PNG, FIG, EPS, FIG)
* (opt) box-whisker plots (type PNG, FIG, EPS, FIG)
* (opt) statistic distribution (type PNG, FIG, EPS, FIG)
* (opt) statistic parameters (type DAT, CSV, LATEX)
* (opt) comparison data (type DAT, CSV, MAT)
* (opt) statistic overview (type DAT, CSV, MAT)

|methodology=
This program was created with [[MATLAB]] and [[PROGHOME]] methods.

|preprocessor=[[NCDELTA]]
|postprocessor=[[MATLAB]]
|language=MATLAB r2019a
|add_software= keine
|contact_original=[mailto:robert.hagen@baw.de R. Hagen]
|contact_maintenance=[mailto:robert.hagen@baw.de R. Hagen]
|documentation=
* Template Files:
** template files available in '''$PROGHOME/examples/ncpolo/'''
}}

NCDELTA

2020-04-16T10:18:40Z

Ak3rhage:

{{ProgramDescription
|name_de=NCDELTA
|name=NCDELTA
|version=January 2020
|version_descr=January 2020
|catchwords=
postprocessor 
differences of synoptic data (with optional restriction of time period) 
differences of characteristic numbers 
differences for extensive quantities 
input data for Taylor diagram 
median, percentiles (Q01, Q05, Q95, Q99) 
skill score according to Murphy (1988) equation 4 
skill score according to Taylor (2001) equations 4 and 5 
parallelization using [http://openmp.org/wp/ OpenMP] 
[[NetCDF#Quality assurance using NetCDF attributes|automatic quality assurance (value range)]] 
automatic adjustment of number of READ data to chunk size of data 
automatic setting of WRITE chunk sizes for written variables 
Storage of the content of the ASCII input control files in [[CF-NETCDF.NC|netcdf.nc]] (as a variable) 
Storage of [https://en.wikipedia.org/wiki/MD5 MD5 hash values] of input files in [[CF-NETCDF.NC|netcdf.nc]] (as a variable) 
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/]).''

|shortdescription=
Program computes differences for comparable variables (primary variable pairs) as well as additional statistical data derived from primary differences, but also data for Taylor diagrams (details see [[Differences of Calculated Results]]) can be computed for some types of data. Finding the primary variable pairs is done in an essentially automatical manner but can be altered to some extent by the user (see [[NCDELTA.DAT|ncdelta.dat]]). Primary differences are computed according to ''variant data'' '''minus''' ''reference data''.

Requirements for time-dependent primary variable pairs with individual constant time step:
# both data sets may contain a ''different'' number of data items (time steps), but the length of the time period to be compared must be identical, whereas the periods to be compared may differ ;
# constant time step for each data set may differ from each other, but the larger time step must an integer multiple of the smaller one.

Requirements for time-dependent primary variable pairs with variable time step:
# both data sets must contain an ''identical'' number of data items (time steps), with periods allowed to be different.

Remarks concerning the spatial location of data:
# data sets may differ with respect to their geographical location;
# areas for which data are defined must overlap to some degree;
# coordinates may be given in different coordinate systems, e. g. Gauß-Krüger and UTM;
# data for a location are compared with data for the nearest lying location, as far as the distance between the different locations does not exceed a prescribed maximum (see [[NCDELTA.DAT|ncdelta.dat]]).

Remarks concerning the comparison of extensive variables:
# for extensive variables the respective sizes of the computational cells (area, length) are taken into account.

|inputfiles=
# '''general input data''' (file type [[NCDELTA.DAT|ncdelta.dat]]);
# '''reference data''' (file type [[CF-NETCDF.NC]]);
# '''variant data''' (file type [[CF-NETCDF.NC]]);
# for [[NetCDF#Automatic quality assurance using NetCDF attributes|automatic quality assurance]] (file type [[BOUNDS.CFG.DAT|bounds_verify.dat]]).

|outputfiles=
# '''results''' (file type [[CF-NETCDF.NC]])
# (optional) informative '''printer file''' of program execution (file type ncdelta.sdr)
# (optional) '''trace''' of program execution (file type ncdelta.trc)

|methodology=
The program is subdivided into the following sections:
# read, check and print steering data prescribed by the user;
# read metadata for ''reference data'';
# read metadata for ''variant data'';
# copy metadata for reference as well as variant data to program specific data structures;
# compare metadata for substantial discrepancies (e. g. reference locations) between data sets;
# classify all reference as well as variant data;
# find primary variable pairs: each variant variable has one partner reference variable; primary computational results will be later derived from primary variable pairs;
# derive variables to be copied from reference as well as variant data file into the result file;
# compute interpolation matrices required for interpolation between reference data locations and variant data locations;
# create all metadata for the result file; essentially they stem from variables to be copied, from primary result variables, newly generated coordinate variables (time, vertical), as well as newly derived or to be copied measure and auxiliary variables;
# copy selceted variables from reference as well as variant file to the result file;
# compute all primary variables, (new) time and vertical coordinate variables, as well as weights and auxiliary variables. For primary variables optionally available axiliary variables with ''standard_name'' modifier ''status_flag'' are taken into account in case meaning ''good'' is represented by an appropriate flag (bit).
# with respect of the different skill scores used and computed by the program - references:
#* Murphy, Allan H. (1988) "Skill Scores Based on the Mean Square Error and Their Relationship to the Correlation Coefficient". Monthly Weather Review, Dec. 1988, Seiten 2417 - 2424.
#* Taylor, Karl E. (2001) "Summarizing multiple aspects of model performance in a single diagram". Journal of Geophysical Research, Vol 106, No. D7, April 16, 2001, Pages 7183 - 7192.
Just in case '''HDF error''' is detected during read of a data record, the program tries to reconstruct the wanted data set from adjacent (in time) records for the same variable. This type of repair works for time dependent variables only.

|preprocessor=[[BOE2NC]], [[DATACONVERT]], [[NCAGGREGATE]], [[NCANALYSE]], [[NCCHUNKIE]], [[NCCUTOUT]], [[NCRCATMAT]], [[NetCDF Operators]], [[UNK]], [[UNTRIM2007]], [[UNTRIM2]]
|postprocessor=[[DAVIT]], [[NCAUTO]], [[NCCHUNKIE]], [[NCPOLO]], [[NCPLOT]], [[NCCUTOUT]], [[NC2TABLE]], [[NCVIEW2D]], [[PLOTTS]], [[TAYLORDIAGRAM]]
|language=Fortran95
|add_software=none
|contact_original=[mailto:guenther.lang@baw.de G. Lang], [mailto:susanne.spohr@baw.de S. Spohr]
|contact_maintenance=[mailto:guenther.lang@baw.de G. Lang], [mailto:susanne.spohr@baw.de S. Spohr]
|documentation=
* Presentations (available in German only):
** 2015-07-15: [http://ewisa.baw.de/files/12835_tv12_2015_07_15_ncdelta_g_lang.pdf ''NCDELTA - Differenzen neu berechnet''].
* Template Files:
** template files available in '''$PROGHOME/examples/ncdelta'''
}}

NCPOLO

2020-04-16T10:17:44Z

Ak3rhage:

{{ProgramDescription
|name_de=NCPOLO
|name=NCPOLO
|version=August 2019
|version_descr=April 2020
|catchwords=Postprocessor 
time series 
hodograph 
scatterplots 
model skill

|shortdescription=
[[NCPOLO]] is applied in model calibration and validation. It corroborates validation illustration and skill scores combined with various export possibilities. With [[NCPOLO]], a observation-prediction comparison can be performed quickly. For a successful application of [[NCPOLO]], all measurements and model data must be available in pooled [[CF-NETCDF.NC|cf-netcdf.nc]] data. A time and space correlated difference, which can be interpreted by [[NCPOLO]] must be created with [[NCDELTA]].

Remarks:
* One should use [[BOE2NC]] for the preprocessing of non-pooled [[BOEWRT.DAT]] data
* Measurements should be checked, as [[NCPOLO]] does not perform any plausibility checks on input data
* Measurement names must be one-of-a-kind, as more than one measurement (e. g. multiple depths) are not possible to interpret yet.
* Stations are named from the long_name of the [[NCDELTA]] variant
* Model data can be provided in 2d and 3d
* [[NCDELTA]] '''must''' be run with ''with_original_data = .true.''
* The station name will be used troughout illustrations and skill scores. Thus it is smart to chose a short name.
* The processing of chunked data is usually faster, when using [[NCDELTA]]. One can chunk a [[CF-NETCDF.NC|cf-netcdf.nc]] file using [[NCCHUNKIE]].
* As the output can be defined in multiple languages, with more than 5 detailed times per tide gauge, the output mass can grow quickly to more than 1,000. Therefore, a user should only enable the illustrations, which are absolutely required.

Output of [[NCPOLO]]:
* time series (complete, parts)
* scatter plots (colored by density, uniform)
* hodographs of current (colored by density, uniform)
* box-whisker error distribution
* statistics (33 parameters)
* data export (per gauge)
* statistics export (per gauge, all gauges)

|inputfiles=
* req: steering[[NCPOLO.DAT]]

|outputfiles=
* (req) log (type *.sdr)
* (req) errors and warnings (type *.err)
* (req) time series (type PNG, FIG, EPS, FIG)
* (opt) scatter plot (type PNG, FIG, EPS, FIG)
* (opt) hodograph (type PNG, FIG, EPS, FIG)
* (opt) box-whisker plots (type PNG, FIG, EPS, FIG)
* (opt) statistic distribution (type PNG, FIG, EPS, FIG)
* (opt) statistic parameters (type DAT, CSV, LATEX)
* (opt) comparison data (type DAT, CSV, MAT)
* (opt) statistic overview (type DAT, CSV, MAT)

|preprocessor=[[NCDELTA]]
|postprocessor=[[MATLAB]]
|language=MATLAB r2019a
|add_software= keine
|contact_original=[mailto:robert.hagen@baw.de R. Hagen]
|contact_maintenance=[mailto:robert.hagen@baw.de R. Hagen]
|documentation=
* Template Files:
** template files available in '''$PROGHOME/examples/ncpolo/'''
}}

NCPOLO

2020-04-16T10:12:28Z

Ak3rhage: Created page with "{{ProgramDescription |name_de=NCPOLO |name=NCPOLO |version=August 2019 |version_descr=April 2020 |catchwords=Postprocessor time series hodograph scatterplots..."

{{ProgramDescription
|name_de=NCPOLO
|name=NCPOLO
|version=August 2019
|version_descr=April 2020
|catchwords=Postprocessor 
time series 
hodograph 
scatterplots 
model skill

|shortdescription=
[[NCPOLO]] is applied in model calibration and validation. It corroborates validation illustration and skill scores combined with various export possibilities. With [[NCPOLO]], a observation-prediction comparison can be performed quickly. For a successful application of [[NCPOLO]], all measurements and model data must be available in pooled [[CF-NETCDF.NC|cf-netcdf.nc]] data. A time and space correlated difference, which can be interpreted by [[NCPOLO]] must be created with [[NCDELTA]].

Remarks:
* One should use [[BOE2NC]] for the preprocessing of non-pooled [[BOEWRT.DAT]] data
* Measurements should be checked, as [[NCPOLO]] does not perform any plausibility checks on input data
* Measurement names must be one-of-a-kind, as more than one measurement (e. g. multiple depths) are not possible to interpret yet.
* Stations are named from the long_name of the [[NCDELTA]] variant
* Model data can be provided in 2d and 3d
* [[NCDELTA]] '''must''' be run with ''with_original_data = .true.''
* The station name will be used troughout illustrations and skill scores. Thus it is smart to chose a short name.
* The processing of chunked data is usually faster, when using [[NCDELTA]]. One can chunk a [[CF-NETCDF.NC|cf-netcdf.nc]] file using [[NCCHUNKIE]].
* As the output can be defined in multiple languages, with more than 5 detailed times per tide gauge, the output mass can grow quickly to more than 1,000. Therefore, a user should only enable the illustrations, which are absolutely required.

Output of [[NCPOLO]]:
* time series (complete, parts)
* scatter plots (colored by density, uniform)
* hodographs of current (colored by density, uniform)
* box-whisker error distribution
* statistics (33 parameters)
* data export (per gauge)
* statistics export (per gauge, all gauges)

|Remarks=
# The measurements must be in the format [[BOEWRT.DAT]] and end with *.boewrt.dat
# It is highly recommeded to quality control the data before converting it, as it is rather complicated to adjust values in [[CF-NETCDF.NC|cf-netcdf.nc]] data afterwards.
# If more than one depth value per station is available (e. g. 2 different heights for measurements of salinity), the station name should be changed to for example station_top and station_bottom. Both stations still need an individual water level time series!

|inputfiles=
# req: steering[[BOE2NC.DAT]]
# opt: order of station e. g. order.txt

|outputfiles=
# log (Dateityp *.sdr)
# errors and warnings (Dateityp *.err)
# folder boewrt: original data
# folder boe: data as homogenized by [[ZEITRIO]]
# folder nc: data as homogenized by [[ZEITRIO]], converted by [[DATACONVERT]] and appended by ncks
# folder nc_cat: ncrcat -h of the data in nc

|preprocessor=[[DATACONVERT]], [[ZEITRIO]]
|postprocessor=[[NCANALYSE]], [[NCDVAR]], [[NCPOLO]], [[NCPLOT]], [[NCVIEW2D]], [[NetCDF Operators]]
|language=MATLAB r2019b
|add_software= keine
|contact_original=[mailto:robert.hagen@baw.de R. Hagen]
|contact_maintenance=[mailto:robert.hagen@baw.de R. Hagen]
|documentation=
* Template Files:
** template files available in '''$PROGHOME/examples/boe2nc/'''
}}

NCPLOT

2020-02-25T14:36:18Z

Ak3rhage:

{{ProgramDescription
|name_de=NCPLOT
|name=NCPLOT
|version=January 2020
|version_descr=January 2020
|catchwords=graphical postprocessor 
graphical presentation of CF NetCDF data (unknown attributes are ignored) 
finite element models 
finite difference models 
orthogonal unstructured grid model 
orthogonal unstructured grid model with subgrid information 
conversion or transformation (extensive - intensive) of physical units 
calculation of new quantities (for display) from one or several input data sets 
(optional) filter based on water depth 
(optional) filter based on number of observations 

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/]).''

|shortdescription=
The graphical postprocessor NCPLOT can be used for a graphical presentation
of simulation and analysis results, which is stored in CF NetCDF data format.
The data can be defined on nodes, edges or faces. The program works on 2D-data,
3D-data and on data with details scaled on a subgrid. 
[[File:NcplotBspFaceArea.png|thumb|250px|Picture 1: Salinity with underlaid topography.]]

The sample pictures illustrate the capability of the program NCPLOT. 
[[NCPLOT: Example figures|Example figures: NCPLOT]]

Basically, NCPLOT distinguishes linear from areal chart types.
For area charts the symbolization of the data is depending on the data value
(color legend, proportional arrow).
For linear charts, the values of data series are plotted on an axis.
The symbolization of the data series is independent of the data value.
 

[[NCPLOT: Area Charts|Area Charts]]:
* Map, or top view illustration

[[NCPLOT: Line Charts|Line Charts]]: 
* time series
* profile view
* depth profile

NCPLOT allows you to illustrate different diagrams of different types in one picture.
Line diagrams next to areal charts with static and possibly dynamic parts.
 

Picture series: 
Both line and area chart definitions can request the creation of picture series.
A picture can contain static and dynamic image components.
Dynamic components means parts of the image that vary over a picture series.
 

The following rule applies to the program: 
The first read dynamic definition determines the permitted length of the
picture series.
The program aborts, if a further dynamic diagram definition results a
different number of images.
 

Further tests are not carried out.
 

Different series diagrams from dynamic diagram definitions of the same
length are processed by the program. The static picture elements are displayed
on every picture in the series.
 

|inputfiles=
# '''general input data''' (file type [[NCPLOT.DAT|ncplot.dat]])
# '''result files''' (file type [[CF-NETCDF.NC]])
# file with '''interval definitions''' for color legends (file type [[BOUNDS.CFG.DAT|bounds.cfg.dat]]) Hint: (Recommended) Local configuration file or file from the directory ''$PROGHOME/cfg/''.
# file with '''list of definitions of palettes''' (file type [[PALETTES.CFG.DAT|palettes.cfg.dat]]) Hint: (Recommended) Provided file from the directory ''$PROGHOME/cfg/'' or local configuration file.
# file with '''definitions of colors''' (file type [[COLORS.CFG.DAT|colors.cfg.dat]]) Hint: (Recommended) Provided file from the directory ''$PROGHOME/cfg/'' or local configuration file.

For NCPLOT the following standard configuration files from the directory '''''$PROGHOME/cfg/''''' are required:
* GKS parameter file: '''gkssystem.computername.dat'''

|outputfiles=
# '''plot metafiles''' (CGM format)
# (optional) informative '''printer file''' of program execution (file type ncplot.sdr)
# (optional) '''trace''' of program execution (file type ncplot.trc)

|methodology=
NCPLOT is a pure plot program without any user interaction at runtime.
The layout of the picture and the graphical presentation of the data has to be
described in the steering file.
 

NCPLOT creates vector graphics in CGM format.
 

For special data files it is possible to exclude data at places with low water
coverage from the display. The technic works only on original UnTRIM result files
in CF NetCDF format.
 

Just in case '''HDF error''' is detected during read of a data record,
the program tries to reconstruct the wanted data set from adjacent (in time)
records for the same variable.
This type of repair works for time dependent variables only.
 

|preprocessor=[[BOE2NC]], [[DATACONVERT]], [[GRIDCONVERT]], [[NCAGGREGATE]], [[NCANALYSE]], [[NCCUTOUT]], [[NCDELTA]], [[UNK]], [[UNTRIM2007]], [[UNTRIM2]]
|postprocessor=---
|language=Fortran95
|add_software=GKS (by GTS-Gral)
|contact_original=[mailto:guenther.lang@baw.de G. Lang], [mailto:susanne.spohr@baw.de S. Spohr]
|contact_maintenance=[mailto:guenther.lang@baw.de G. Lang], [mailto:susanne.spohr@baw.de S. Spohr]
|documentation=
template files available in '''$PROGHOME/examples/ncplot'''
}}

NCANALYSE

2020-02-25T14:35:57Z

Ak3rhage:

{{ProgramDescription
|name_de=NCANALYSE
|name=NCANALYSE
|version=February 2020
|version_descr=February 2020
|catchwords=
data analysis 
postprocessor 
synoptic data sets 
measured time series data (optionally with [http://cfconventions.org/Data/cf-conventions/cf-conventions-1.6/build/cf-conventions.html#flags flag variables] for a more detailed qualification of data) 
depth averaged (2D) and depth structured data (3D) with z-layers 
[[Tidal Characteristic Numbers of Water Level|tidal characteristic numbers of water level]] 
[[Tidal Characteristic Numbers of Current|tidal characteristic numbers of current]], [[Tidal Characteristic Numbers of Water Transport|tidal characteristic numbers of water transport]] 
[[Tidal Characteristic Numbers of Salinity|tidal characteristic numbers of salinity]], [[Tidal Characteristic Numbers of Salt Transport|tidal characteristic numbers of salt transport]] 
[[Tidal Characteristic Numbers of Temperature|tidal characteristic numbers of temperature]], [[Tidal Characteristic Numbers of Heat Transport|tidal characteristic numbers of heat transport]] 
[[Tidal Characteristic Numbers of Suspended Sediment Transport|tidal characteristic numbers of suspended sediment]],
[[Tidal Characteristic Numbers of Suspended Load Transport|tidal characteristic numbers of suspended load transport]] 
[[Tidal Characteristic Numbers of Tracer Load|tidal characteristic numbers of tracer load]], [[Tidal Characteristic Numbers of Tracer Load Transport|tidal characteristic numbers of tracer load transport]] 
[[Tidal Characteristic Numbers of Eff. Bed Shear Stress Action|tidal characteristic numbers of effective bed shear stress]] 
[[Tidal Characteristic Numbers of Bed Load Transport|tidal characteristic numbers of bed load transport]] 
[[Harmonic Analysis of Water Level|harmonic analysis of water level]] 
[[Harmonic Analysis of Current Velocity|harmonic analysis of current velocity]] 
[[Characteristic Numbers of Water Level (independent of tides)|characteristic numbers of water level (independent of tides)]] 
[[Characteristic Numbers of Current Velocity (independent of tides)|characteristic numbers of current velocity (independent of tides)]] 
[[Characteristic Numbers of Salinity (independent of tides)|characteristic numbers of salinity (independent of tides)]] 
[[Characteristic Numbers of Temperature (independent of tides)|characteristic numbers of temperature (independent of tides)]] 
[[Characteristic Numbers of Suspended Sediment Concentration (independent of tides)|characteristic numbers of suspended sediment concentration (independent of tides)]] 
[[Characteristic Numbers of Tracer Load (independent of tides)|characteristic numbers of tracer load (independent of tides)]] 
[[Characteristic Numbers of Oxygen Concentration (independent of tides)|characteristic numbers of oxygen concentration (independent of tides)]] 
[[Characteristic Numbers of Morphodynamics (independent of tides)|characteristic numbers of morphodynamics (independent of tides)]] 
[[Characteristic Numbers of Bed Load Transport (independent of tides)|characteristic numbers of bedload transport (independent of tides)]] 
[[Characteristic Numbers of Eff. Bed Shear Stress (independent of tides)|characteristic numbers of effective bed shear stress (independent of tides)]] 
[[Characteristic Numbers of Water Transport (independent of tides)|characteristic numbers of water transport (independent of tides)]]
 
[[Characteristic Numbers of Salt Transport (independent of tides)|characteristic numbers of salt transport (independent of tides)]]
 
[[Characteristic Numbers of Heat Transport (independent of tides)|characteristic numbers of heat transport (independent of tides)]]
 
[[Characteristic Numbers of Tracer Transport (independent of tides)|characteristic numbers of tracer transport (independent of tides)]] 
[[Characteristic Numbers of Suspended Sediment Transport (independent of tides)|characteristic numbers of suspended sediment transport (independent of tides)]] 
[[Characteristic Numbers of Sediment Transport (independent of tides)|characteristic numbers of sediment transport (independent of tides)]] (bed and suspended load at the bottom) 
[[Characteristic Numbers of Tidal Energy Transport|characteristic numbers of tidal energy transport]] 
[[Characteristic Numbers of Meteorological Data (independent of tides)|characteristic numbers of meteorological data (wind speed)]] 
[[Characteristic Numbers for Wave and Sea State (independent of tides)|characteristic numbers for wave and sea state (significant wave height)]] 
[[NetCDF|CF NetCDF]] format for 2D/3D data 
orthogonal unstructured grid model 
orthogonal unstructured grid model with subgrid information 
data at individual locations (''Discrete Sampling Geometry'' featureType = '''timeSeriesProfile''') 
data at multiple locations along trajectories (''Discrete Sampling Geometry'' featureType = '''trajectoryProfile''') 
parallelization using [http://openmp.org/wp/ OpenMP] and [http://en.wikipedia.org/wiki/Message_Passing_Interface MPI] (MPI ist not available for the August 2014 version) 
[[NetCDF#Quality assurance using NetCDF attributes|automatic quality assurance (value range)]] 
automatic adjustment of number of READ data to chunk size of data 
automatic setting of WRITE chunk sizes for written variables 
Storage of the content of the ASCII input control files in [[CF-NETCDF.NC|netcdf.nc]] (as a variable) 
Storage of [https://en.wikipedia.org/wiki/MD5 MD5 hash values] of input files in [[CF-NETCDF.NC|netcdf.nc]] (as a variable) 
optional closing of data gaps at reference positions by interpolation 

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/]).''

|shortdescription=
Program NCANALYSE serves as an analysis program for data stored in CF netCDF data files.

|inputfiles=
# '''general input data''' (file type [[NCANALYSE.DAT|ncanalyse.dat]]);
# '''synoptic data sets''' (file type [[CF-NETCDF.NC]]);
# for [[NetCDF#Automatic quality assurance using NetCDF attributes|automatic quality assurance]] (file type [[BOUNDS.CFG.DAT|bounds_verify.dat]]).

|outputfiles=
# '''data analysis result files''' (file type [[CF-NETCDF.NC]])
# (optional) informative '''printer file''' of program execution (file type ncanalyse.sdr)
# (optional) '''trace''' of program execution (file type ncanalyse.trc)

|methodology=
The following data analysis methods are currently available:
* Tidal Characteristic Numbers:
*# [[Tidal Characteristic Numbers of Water Level]];
*# [[Tidal Characteristic Numbers of Current]];
*# [[Tidal Characteristic Numbers of Salinity]];
*# [[Tidal Characteristic Numbers of Temperature]];
*# [[Tidal Characteristic Numbers of Suspended Sediment Transport|Tidal Characteristic Numbers of Suspended Sediment]];
*# [[Tidal Characteristic Numbers of Tracer Load]];
*# [[Tidal Characteristic Numbers of Eff. Bed Shear Stress Action|Tidal Characteristic Numbers of Effective Bed Shear Stress]];
*# [[Tidal Characteristic Numbers of Bed Load Transport]].
* Tide-dependent Characteristic Numbers for Transport-Processes (based on ''exact'' integrals):
*# [[Tidal Characteristic Numbers of Water Transport]];
*# [[Tidal Characteristic Numbers of Salt Transport]];
*# [[Tidal Characteristic Numbers of Heat Transport]];
*# [[Tidal Characteristic Numbers of Suspended Load Transport]];
*# [[Tidal Characteristic Numbers of Tracer Load Transport]].
* Harmonic Analysis:
*# [[Harmonic Analysis of Water Level]];
*# [[Harmonic Analysis of Current Velocity]].
* Tide-Independent Characteristic Numbers:
*# [[Characteristic Numbers of Water Level (independent of tides)]];
*# [[Characteristic Numbers of Current Velocity (independent of tides)]];
*# [[Characteristic Numbers of Salinity (independent of tides)]];
*# [[Characteristic Numbers of Temperature (independent of tides)]];
*# [[Characteristic Numbers of Suspended Sediment Concentration (independent of tides)]];
*# [[Characteristic Numbers of Tracer Load (independent of tides)]];
*# [[Characteristic Numbers of Oxygen Concentration (independent of tides)]];
*# [[Characteristic Numbers of Morphodynamics (independent of tides)]];
*# [[Characteristic Numbers of Bed Load Transport (independent of tides)]];
*# [[Characteristic Numbers of Eff. Bed Shear Stress (independent of tides)]]. 
* Tide-Independent Characteristic Numbers for Transport-Processes (based on ''exact'' integrals):
*# [[Characteristic Numbers of Water Transport (independent of tides)]];
*# [[Characteristic Numbers of Water Transport (independent of tides)]];
*# [[Characteristic Numbers of Salt Transport (independent of tides)]];
*# [[Characteristic Numbers of Heat Transport (independent of tides)]];
*# [[Characteristic Numbers of Tracer Transport (independent of tides)]];
*# [[Characteristic Numbers of Suspended Sediment Transport (independent of tides)]];
*# [[Characteristic Numbers of Sediment Transport (independent of tides)]] (bed an suspended load at the bottom).
* Tidal Energy Transport:
*# [[Characteristic Numbers of Tidal Energy Transport]]
* Characteristic Numbers of Meteorological Data:
*# [[Characteristic Numbers of Meteorological Data (independent of tides)|wind speed]].
* Characteristic Numbers for Wave and Sea State:
*# [[Characteristic Numbers for Wave and Sea State (independent of tides)|significant wave height]].

Just in case '''HDF error''' is detected during read of a data record, the program tries to reconstruct the wanted data set from adjacent (in time) records for the same variable. This type of repair works for time dependent variables only.

|preprocessor=[[BOE2NC]], [[DATACONVERT]], [[GRIDCONVERT]], [[NCAGGREGATE]], [[NCCHUNKIE]], [[NCCUTOUT]], [[NetCDF Operators]], [[QUICKPLOT]], [[UNTRIM2007]], [[UNTRIM2]]
|postprocessor=[[DAVIT]], [[DISPLAY_CONTROL_VOLUMES]], [[NCAGGREGATE]], [[NCAUTO]], [[NCCHUNKIE]], [[NCCUTOUT]], [[NCDELTA]], [[NCPLOT]], [[NC2TABLE]], [[PLOTPROFILZEIT]], [[PLOTTS]]
|language=Fortran95
|add_software=---
|contact_original=[mailto:guenther.lang@baw.de G. Lang]
|contact_maintenance=[mailto:guenther.lang@baw.de G. Lang], [mailto:susanne.spohr@baw.de S. Spohr]
|documentation=
* Presentations (available in German only):
** 2015-05-29: [http://ewisa.baw.de/files/12556_tv12_2015_05_29_tide_energie_transport_g_lang.pdf ''Tidewelle und Energietransport''] (DOI: [http://dx.doi.org/10.13140/RG.2.2.31352.14089 http://dx.doi.org/10.13140/RG.2.2.31352.14089]);
** 2014-12-03: [http://ewisa.baw.de/files/11284_tv12_2014_12_03_ncanalyse_lzks_g_lang.pdf ''NCANALYSE - Tideunabhängige Kennwerte des Salzgehalts''];
** 2014-12-03: [http://ewisa.baw.de/files/11285_tv12_2014_12_03_ncanalyse_tdks_g_lang.pdf ''NCANALYSE - Tidekennwerte des Salzgehalts''];
** 2014-10-08: [http://ewisa.baw.de/files/10587_tv12_2014_10_08_ncanalyse_lzkv_g_lang.pdf ''NCANALYSE - Tideunabhängige Kennwerte der Strömung''];
** 2014-09-10: [http://ewisa.baw.de/files/10588_tv12_2014_09_10_allgemein_g_lang.pdf ''NCANALYSE - Tidekennwerte der Strömung''];
** 2013-08-07: [http://ewisa.baw.de/files/08510_speech_2013-08-07.pdf ''NCANALYSE - Tideunabhängige Kennwerte des Wasserstands''];
** 2013-05-15: [http://ewisa.baw.de/files/08500_speech_2013-05-15.pdf ''NCANALYSE - Daten aus CF netCDF Dateien analysieren''].
* Template input files:
** template files available in '''$PROGHOME/examples/ncanalyse'''
}}

NCDELTA

2020-02-25T14:35:36Z

Ak3rhage:

{{ProgramDescription
|name_de=NCDELTA
|name=NCDELTA
|version=January 2020
|version_descr=January 2020
|catchwords=
postprocessor 
differences of synoptic data (with optional restriction of time period) 
differences of characteristic numbers 
differences for extensive quantities 
input data for Taylor diagram 
median, percentiles (Q01, Q05, Q95, Q99) 
skill score according to Murphy (1988) equation 4 
skill score according to Taylor (2001) equations 4 and 5 
parallelization using [http://openmp.org/wp/ OpenMP] 
[[NetCDF#Quality assurance using NetCDF attributes|automatic quality assurance (value range)]] 
automatic adjustment of number of READ data to chunk size of data 
automatic setting of WRITE chunk sizes for written variables 
Storage of the content of the ASCII input control files in [[CF-NETCDF.NC|netcdf.nc]] (as a variable) 
Storage of [https://en.wikipedia.org/wiki/MD5 MD5 hash values] of input files in [[CF-NETCDF.NC|netcdf.nc]] (as a variable) 
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/]).''

|shortdescription=
Program computes differences for comparable variables (primary variable pairs) as well as additional statistical data derived from primary differences, but also data for Taylor diagrams (details see [[Differences of Calculated Results]]) can be computed for some types of data. Finding the primary variable pairs is done in an essentially automatical manner but can be altered to some extent by the user (see [[NCDELTA.DAT|ncdelta.dat]]). Primary differences are computed according to ''variant data'' '''minus''' ''reference data''.

Requirements for time-dependent primary variable pairs with individual constant time step:
# both data sets may contain a ''different'' number of data items (time steps), but the length of the time period to be compared must be identical, whereas the periods to be compared may differ ;
# constant time step for each data set may differ from each other, but the larger time step must an integer multiple of the smaller one.

Requirements for time-dependent primary variable pairs with variable time step:
# both data sets must contain an ''identical'' number of data items (time steps), with periods allowed to be different.

Remarks concerning the spatial location of data:
# data sets may differ with respect to their geographical location;
# areas for which data are defined must overlap to some degree;
# coordinates may be given in different coordinate systems, e. g. Gauß-Krüger and UTM;
# data for a location are compared with data for the nearest lying location, as far as the distance between the different locations does not exceed a prescribed maximum (see [[NCDELTA.DAT|ncdelta.dat]]).

Remarks concerning the comparison of extensive variables:
# for extensive variables the respective sizes of the computational cells (area, length) are taken into account.

|inputfiles=
# '''general input data''' (file type [[NCDELTA.DAT|ncdelta.dat]]);
# '''reference data''' (file type [[CF-NETCDF.NC]]);
# '''variant data''' (file type [[CF-NETCDF.NC]]);
# for [[NetCDF#Automatic quality assurance using NetCDF attributes|automatic quality assurance]] (file type [[BOUNDS.CFG.DAT|bounds_verify.dat]]).

|outputfiles=
# '''results''' (file type [[CF-NETCDF.NC]])
# (optional) informative '''printer file''' of program execution (file type ncdelta.sdr)
# (optional) '''trace''' of program execution (file type ncdelta.trc)

|methodology=
The program is subdivided into the following sections:
# read, check and print steering data prescribed by the user;
# read metadata for ''reference data'';
# read metadata for ''variant data'';
# copy metadata for reference as well as variant data to program specific data structures;
# compare metadata for substantial discrepancies (e. g. reference locations) between data sets;
# classify all reference as well as variant data;
# find primary variable pairs: each variant variable has one partner reference variable; primary computational results will be later derived from primary variable pairs;
# derive variables to be copied from reference as well as variant data file into the result file;
# compute interpolation matrices required for interpolation between reference data locations and variant data locations;
# create all metadata for the result file; essentially they stem from variables to be copied, from primary result variables, newly generated coordinate variables (time, vertical), as well as newly derived or to be copied measure and auxiliary variables;
# copy selceted variables from reference as well as variant file to the result file;
# compute all primary variables, (new) time and vertical coordinate variables, as well as weights and auxiliary variables. For primary variables optionally available axiliary variables with ''standard_name'' modifier ''status_flag'' are taken into account in case meaning ''good'' is represented by an appropriate flag (bit).
# with respect of the different skill scores used and computed by the program - references:
#* Murphy, Allan H. (1988) "Skill Scores Based on the Mean Square Error and Their Relationship to the Correlation Coefficient". Monthly Weather Review, Dec. 1988, Seiten 2417 - 2424.
#* Taylor, Karl E. (2001) "Summarizing multiple aspects of model performance in a single diagram". Journal of Geophysical Research, Vol 106, No. D7, April 16, 2001, Pages 7183 - 7192.
Just in case '''HDF error''' is detected during read of a data record, the program tries to reconstruct the wanted data set from adjacent (in time) records for the same variable. This type of repair works for time dependent variables only.

|preprocessor=[[BOE2NC]], [[DATACONVERT]], [[NCAGGREGATE]], [[NCANALYSE]], [[NCCHUNKIE]], [[NCCUTOUT]], [[NCRCATMAT]], [[NetCDF Operators]], [[UNK]], [[UNTRIM2007]], [[UNTRIM2]]
|postprocessor=[[DAVIT]], [[NCAUTO]], [[NCCHUNKIE]], [[NCPLOT]], [[NCCUTOUT]], [[NC2TABLE]], [[NCVIEW2D]], [[PLOTTS]], [[TAYLORDIAGRAM]]
|language=Fortran95
|add_software=none
|contact_original=[mailto:guenther.lang@baw.de G. Lang], [mailto:susanne.spohr@baw.de S. Spohr]
|contact_maintenance=[mailto:guenther.lang@baw.de G. Lang], [mailto:susanne.spohr@baw.de S. Spohr]
|documentation=
* Presentations (available in German only):
** 2015-07-15: [http://ewisa.baw.de/files/12835_tv12_2015_07_15_ncdelta_g_lang.pdf ''NCDELTA - Differenzen neu berechnet''].
* Template Files:
** template files available in '''$PROGHOME/examples/ncdelta'''
}}

BOE2NC

2020-02-25T14:34:37Z

Ak3rhage: Created page with "{{ProgramDescription |name_de=BOE2NC |name=BOE2NC |version=January 2020 |version_descr=Febuary 2020 |catchwords=Preprocessor conversion BOEWRT.DAT CF-N..."

{{ProgramDescription
|name_de=BOE2NC
|name=BOE2NC
|version=January 2020
|version_descr=Febuary 2020
|catchwords=Preprocessor 
conversion 
[[BOEWRT.DAT]] 
[[CF-NETCDF.NC|cf-netcdf.nc]]

|shortdescription=
[[BOE2NC]] is applied in order to convert an amount of measured time series from the [[BOEWRT]] format to individual and pooled [[CF-NETCDF.NC|cf-netcdf.nc]] data.

# all [[BOEWRT.DAT]] data must be in one directory
# only water level, current, salinity, temperature and sediment concentration are permitted at the moment
# current must contain a magnitude and a direction
# the [[BOEWRT.DAT]] header '''must''' contain a timezone, an epsg-code, coordinates and the number of the wet point.
# measured data should be quality controlled by the user, as no checks are run by [[BOE2NC]]
# the order of the measured stations can be manipulated by placing a textfile in the measurement directory, which must contain the names of all stations
# measured data is divided into water levels and non-water levels
# data which is not a water level, must have an according water level, as they are concentated in the water level file lateron.
# if no water level exists at the location, the user may use model data, reanalyzed harmonic constituents, or measurements, which are somewhat closeby (+-10km seems to work fine).
# if a parameter is not available at a location, fill values are added
# it is possible to neglect parameters, as [[BOE2NC]] executition may be expensive.

|Error sources:=
# one or more [[BOEWRT.DAT]] header is incomplete or incorrect.
# station names are not correct.
# a non-water level does not have an according water level.

|Remarks=
# The measurements must be in the format [[BOEWRT.DAT]] and end with *.boewrt.dat
# It is highly recommeded to quality control the data before converting it, as it is rather complicated to adjust values in [[CF-NETCDF.NC|cf-netcdf.nc]] data afterwards.
# If more than one depth value per station is available (e. g. 2 different heights for measurements of salinity), the station name should be changed to for example station_top and station_bottom. Both stations still need an individual water level time series!

|inputfiles=
# req: steering[[BOE2NC.DAT]]
# opt: order of station e. g. order.txt

|outputfiles=
# log (Dateityp *.sdr)
# errors and warnings (Dateityp *.err)
# folder boewrt: original data
# folder boe: data as homogenized by [[ZEITRIO]]
# folder nc: data as homogenized by [[ZEITRIO]], converted by [[DATACONVERT]] and appended by ncks
# folder nc_cat: ncrcat -h of the data in nc

|preprocessor=[[ZEITRIO]], [[DATACONVERT]]
|postprocessor=[[NCDELTA]], [[NCANALYSE]], [[NCPOLO]], [[NCPLOT]], [[NCVIEW2D]], [[NetCDF Operators]]
|language=MATLAB r2019b
|add_software= keine
|contact_original=[mailto:robert.hagen@baw.de R. Hagen]
|contact_maintenance=[mailto:robert.hagen@baw.de R. Hagen]
|documentation=
* Template Files:
** template files available in '''$PROGHOME/examples/boe2nc/'''
}}

NCDELTA

2020-02-25T14:15:27Z

Ak3rhage:

{{ProgramDescription
|name_de=NCDELTA
|name=NCDELTA
|version=January 2020
|version_descr=January 2020
|catchwords=
postprocessor 
differences of synoptic data (with optional restriction of time period) 
differences of characteristic numbers 
differences for extensive quantities 
input data for Taylor diagram 
median, percentiles (Q01, Q05, Q95, Q99) 
skill score according to Murphy (1988) equation 4 
skill score according to Taylor (2001) equations 4 and 5 
parallelization using [http://openmp.org/wp/ OpenMP] 
[[NetCDF#Quality assurance using NetCDF attributes|automatic quality assurance (value range)]] 
automatic adjustment of number of READ data to chunk size of data 
automatic setting of WRITE chunk sizes for written variables 
Storage of the content of the ASCII input control files in [[CF-NETCDF.NC|netcdf.nc]] (as a variable) 
Storage of [https://en.wikipedia.org/wiki/MD5 MD5 hash values] of input files in [[CF-NETCDF.NC|netcdf.nc]] (as a variable) 
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/]).''

|shortdescription=
Program computes differences for comparable variables (primary variable pairs) as well as additional statistical data derived from primary differences, but also data for Taylor diagrams (details see [[Differences of Calculated Results]]) can be computed for some types of data. Finding the primary variable pairs is done in an essentially automatical manner but can be altered to some extent by the user (see [[NCDELTA.DAT|ncdelta.dat]]). Primary differences are computed according to ''variant data'' '''minus''' ''reference data''.

Requirements for time-dependent primary variable pairs with individual constant time step:
# both data sets may contain a ''different'' number of data items (time steps), but the length of the time period to be compared must be identical, whereas the periods to be compared may differ ;
# constant time step for each data set may differ from each other, but the larger time step must an integer multiple of the smaller one.

Requirements for time-dependent primary variable pairs with variable time step:
# both data sets must contain an ''identical'' number of data items (time steps), with periods allowed to be different.

Remarks concerning the spatial location of data:
# data sets may differ with respect to their geographical location;
# areas for which data are defined must overlap to some degree;
# coordinates may be given in different coordinate systems, e. g. Gauß-Krüger and UTM;
# data for a location are compared with data for the nearest lying location, as far as the distance between the different locations does not exceed a prescribed maximum (see [[NCDELTA.DAT|ncdelta.dat]]).

Remarks concerning the comparison of extensive variables:
# for extensive variables the respective sizes of the computational cells (area, length) are taken into account.

|inputfiles=
# '''general input data''' (file type [[NCDELTA.DAT|ncdelta.dat]]);
# '''reference data''' (file type [[CF-NETCDF.NC]]);
# '''variant data''' (file type [[CF-NETCDF.NC]]);
# for [[NetCDF#Automatic quality assurance using NetCDF attributes|automatic quality assurance]] (file type [[BOUNDS.CFG.DAT|bounds_verify.dat]]).

|outputfiles=
# '''results''' (file type [[CF-NETCDF.NC]])
# (optional) informative '''printer file''' of program execution (file type ncdelta.sdr)
# (optional) '''trace''' of program execution (file type ncdelta.trc)

|methodology=
The program is subdivided into the following sections:
# read, check and print steering data prescribed by the user;
# read metadata for ''reference data'';
# read metadata for ''variant data'';
# copy metadata for reference as well as variant data to program specific data structures;
# compare metadata for substantial discrepancies (e. g. reference locations) between data sets;
# classify all reference as well as variant data;
# find primary variable pairs: each variant variable has one partner reference variable; primary computational results will be later derived from primary variable pairs;
# derive variables to be copied from reference as well as variant data file into the result file;
# compute interpolation matrices required for interpolation between reference data locations and variant data locations;
# create all metadata for the result file; essentially they stem from variables to be copied, from primary result variables, newly generated coordinate variables (time, vertical), as well as newly derived or to be copied measure and auxiliary variables;
# copy selceted variables from reference as well as variant file to the result file;
# compute all primary variables, (new) time and vertical coordinate variables, as well as weights and auxiliary variables. For primary variables optionally available axiliary variables with ''standard_name'' modifier ''status_flag'' are taken into account in case meaning ''good'' is represented by an appropriate flag (bit).
# with respect of the different skill scores used and computed by the program - references:
#* Murphy, Allan H. (1988) "Skill Scores Based on the Mean Square Error and Their Relationship to the Correlation Coefficient". Monthly Weather Review, Dec. 1988, Seiten 2417 - 2424.
#* Taylor, Karl E. (2001) "Summarizing multiple aspects of model performance in a single diagram". Journal of Geophysical Research, Vol 106, No. D7, April 16, 2001, Pages 7183 - 7192.
Just in case '''HDF error''' is detected during read of a data record, the program tries to reconstruct the wanted data set from adjacent (in time) records for the same variable. This type of repair works for time dependent variables only.

|preprocessor=[[DATACONVERT]], [[NCAGGREGATE]], [[NCANALYSE]], [[NCCHUNKIE]], [[NCCUTOUT]], [[NCRCATMAT]], [[NetCDF Operators]], [[UNK]], [[UNTRIM2007]], [[UNTRIM2]]
|postprocessor=[[DAVIT]], [[NCAUTO]], [[NCCHUNKIE]], [[NCPLOT]], [[NCCUTOUT]], [[NC2TABLE]], [[NCVIEW2D]], [[PLOTTS]], [[TAYLORDIAGRAM]]
|language=Fortran95
|add_software=none
|contact_original=[mailto:guenther.lang@baw.de G. Lang], [mailto:susanne.spohr@baw.de S. Spohr]
|contact_maintenance=[mailto:guenther.lang@baw.de G. Lang], [mailto:susanne.spohr@baw.de S. Spohr]
|documentation=
* Presentations (available in German only):
** 2015-07-15: [http://ewisa.baw.de/files/12835_tv12_2015_07_15_ncdelta_g_lang.pdf ''NCDELTA - Differenzen neu berechnet''].
* Template Files:
** template files available in '''$PROGHOME/examples/ncdelta'''
}}

DATACONVERT

2020-02-25T14:15:05Z

Ak3rhage:

{{ProgramDescription
|name_de=DATACONVERT
|name=DATACONVERT
|version=December 2018
|version_descr=December 2018
|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 [[BOEWRT.DAT#Status-Flag_Variable|status flag variable]]) 
conversion of CF SGRID NetCDF into CF UGRID NetCDF 

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/]).''

|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 
** 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 [[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'''
#: 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'''
#* '''mode 1'''
#**[[DELFT3D.GRD|delft3d.grd]],
#**[[DELFT3D.DEP|delft3d.dep]], and
#**[[DELFT3D.ENC|delft3d.enc]].
#**(optional) [[DELFT3D.DRY|delft3d.dry]],
#**(optional) [[DELFT3D.THD|delft3d.thd]],
#**(optional) [[DELFT3D.LWL|delft3d.lwl]],
#**(optional) [[DELFT3D.EXT|delft3d.ext]], as well as
#**(optional) [[DELFT3D.BND|delft3d.bnd]].
#* '''mode 2''' - no grid file required
#* '''mode 3''' - no grid file required
#* '''mode 4'''
#** [[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]]).
#** [[UNTRIM_GRID.DAT|untrim_grid.dat]] or [[CF-NETCDF.NC|cf-netcdf.nc]] (from [[GRIDCONVERT]]).
#** [[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'''
#* '''mode 1'''
#** [[UNTRIM_GRID.DAT|untrim_grid.dat.]]
#* '''mode 2'''
#** [[GITTER05.DAT and GITTER05.BIN|gitter05.dat/bin]]
#* '''mode 3''' - no grid generated
#* '''mode 4'''
#** (optional) [[CF-NETCDF.NC|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.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]], [[NCPLOT]], [[NCRCATMAT]], [[NC2TABLE]], [[NCVIEW2D]], [[NetCDF Operators]], [[PARTRACE]], [[PGCALC]], [[PLOTPROFILZEIT]], [[PLOTTS]], [[QUICKPLOT]], [[UNK]], [[UNS]], [[VTDK]], [[XTRDATA]], [[XTRLQ2]], [[ZEITR]].
|language=Fortran90
|add_software=-
|contact_original=[mailto:guenther.lang@baw.de G. Lang]
|contact_maintenance=[mailto:guenther.lang@baw.de G. Lang,], [mailto:susanne.spohr@baw.de S. Spohr,], [mailto:peter.schade@baw.de P. Schade,]
|documentation=for example input files please refer to $PROGHOME/examples/dataconvert/
}}

UNK

2020-02-25T14:14:48Z

Ak3rhage:

{{ProgramDescription
|name_de=UNK
|name=UNK
|version=January 2020
|version_descr=January 2020
|catchwords=
post-processor 
numerical simulation 
spectral wave model 
unstructured mesh 
two-dimensional 
transient, non-linear 
action density balance equation 
waves, sea, swell 
wave propagation 
shoaling 
refraction due to depth variation 
refraction due to current variation 
energy input due to wind action 
nonlinear dissipation due to wave-turbulence interactions 
dissipation due to wave-bottom interaction 
portable SMP and SIMD programming using [https://www.openmp.org/ OpenMP] 
automatic determination of time-step in agreement with CFL-condition 
constant alternative bathymetry depth 
dynamic bathymetry depth 
Storage of the content of the ASCII input control files in [[CF-NETCDF.NC|netcdf.nc]] (as a variable) 
Storage of [https://en.wikipedia.org/wiki/MD5 MD5 hash values] of input files in [[CF-NETCDF.NC|netcdf.nc]] (as a variable) 

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/]).''
|shortdescription=
'''Method'''

Program UNK (unstructured k-model) is a post processor for different mathematical current models and can be used to compute the development, propagation and dissipation of waves, sea and swell in the ocean, coastal waters or estuaries. UNK uses as a computational core the Spectral Wave Model with Nonlinear Dissipation - K-Modell, see also literature below - which was developed at the [http://www.gkss.de/ GKSS-Forschungszentrum]. 
From version 7.x on UNK processes input files with alternative or dynamic bathymetry depth, the first indicating a constant depth, which differs from the rigid layer depth.

'''Physical Processes'''

The following physical processes are currently taken into account by UNK:

* conservation of wave action density (action density balance equation);
* advection of wave action density due to currents;
* shoaling of waves due to variation of water depth and/or current velocity;
* refraction of waves due to horizontal gradients of water depth and/or current velocity;
* wind forcing at the free surface;
* dissipation due to turbulent diffusion;
* dissipation due to bottom friction.

'''Computational Results'''

* integral wave parameters for waves, sea and swell:
** significant wave height;
** wave peak period;
** wave mean period TM-1;
** wave period TM1;
** wave period TM2;
** wave mean direction;
** wave mean directional spread;
** acceleration (due to radiation stress).
* two-dimensional spectra for waves, sea and swell:
** frequency-direction wave spectrum.

'''Validation Document'''

See literature below.
|inputfiles=
# '''steering data''' (filetype [[UNK.DAT|unk.dat]]).
# '''steering data for the k-model''' (filetype [[K_MODEL.DAT|k_model.dat]]).

'''Notice''': further input files can be found on the file description pages of the aforementioned files.
|outputfiles=
More details concerning output files can be found on the fact sheet for filetype [[K_MODEL.DAT|k_model.dat]]. In addition to these files the following files are also generated:

# (optional) informative '''printer file''' (Dateityp unk.sdr);
|methodology=
please refer to documentation/literature
|preprocessor=
[[DATACONVERT]], [[DIDASPLIT]], [[DIDAMERGE]], [[METDIDA]], [[TM2DIDA]], [[TR2DIDA]], [[UNTRIM]]
|postprocessor=
[[ABDF]], [[DAVIT]], [[DIDAMERGE]], [[DIDARENAME]], [[DIDASPLIT]], [[HVIEW2D]], [[NCDELTA]], [[NCPLOT]], [[NCVIEW2D]], [[XTRDATA]], [[XTRLQ2]], [[ZEITR]]
|language=Fortran90
|add_software= -
|contact_original=[mailto:guenther.lang@baw.de G. Lang]
|contact_maintenance=[mailto:guenther.lang@baw.de G. Lang], [mailto:susanne.spohr@baw.de S. Spohr], [mailto:peter.schade@baw.de P. Schade]
|documentation=
* example files: please refer to $PROGHOME/examples/unk/
* Schneggenburger, C. (1998) : Spectral Wave Modelling with Nonlinear Dissipation, dissertation, 117 pages, report no. GKSS 98/E/42, [http://www.gkss.de/ GKSS-Forschungszentrum] Geesthacht.
}}

UNTRIM2

2020-02-25T14:14:22Z

Ak3rhage:

{{ProgramDescription
|name_de=UNTRIM2
|name=untrim2
|version=January 2020
|version_descr=January 2020
|catchwords=
numerical simulation 
finite difference method 
finite volume method 
sub grid technology 
unstructured orthogonal grid 
two-dimensional, three-dimensional 
unsteady, non-linear 
conservative and non-conservative ELM for momentum transport 
hydrostatic, non-hydrostatic 
reynoldsaveraged Navier Stokes equations (RANS) 
tidal dynamics (long waves) 
transport of conservative substances (salt, temperature, suspended sediments, tracers) 
two-equation turbulence modelling 
weirs and imposed surfaces (pressurized flow) 
numerical method UNTRIM2 
sub-model for water density EQS 
sub-model for mixing length turbulence modelling MIX 
sub-model for settling velocity modelling SV 
sub-model for morphodynamics SEDIMORPH (partially implemented) 
sub-model for dredging and disposal DredgeSim (not implemented yet) 
sub-model for short waves K-Model 
portable SMP-programming using [http://openmp.org/wp/ OpenMP] 
offline coupling with D-Water Quality [http://www.deltaressystems.com/hydro/product/621497/delft3d-suite Delft3D Suite] 
optional computation of chunk sizes for result variables (see [[NetCDF#File_Chunking|File Chunking]]) 
Storage of the content of the ASCII input control files in [[CF-NETCDF.NC|netcdf.nc]] (as a variable) 
Storage of [https://en.wikipedia.org/wiki/MD5 MD5 hash values] of input files in [[CF-NETCDF.NC|netcdf.nc]] (as a variable) 

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/]).''

|shortdescription=
'''Method'''

The three-dimensional finite difference / finite volume numerical model UNTRIM2 can be used to simulate flow and transport processes in different free-surface flow problems. In contrast to conventional finite difference methods UNTRIM2 is able to operate on an unstructured orthogonal grid. The bathymetry of the model domain can be described with higher resolution compared to the computational grid using sub grid technology.

'''Physical Processes'''

The following physical processes are currently taken into account by UnTRIM2:

* reynoldsaveraged Navier-Stokes equations (RANS)
** local acceleration (inertia)
** advective acceleration
** Coriolis acceleration
** barotropic pressure gradient
** baroclinic pressure gradient
** hydrostatic or non-hydrostatic pressure
** horizontal turbulent viscosity
** vertical turbulent viscosity influenced by density stratification
** bottom friction
** wind friction
** sources and sinks
** bottom evolution
** horizontal acceleration due to wave effects (by means of radiation stress)
** morphodynamic bathymetry
** body forces due to short waves
* transport of substances
** local rate of change of concentration
** advective rate of change of concentration
** optional flux limiter : Minmod, van Leer or Superbee
** horizontal turbulent diffusivity
** vertical turbulent diffusivity influenced by density stratification
** settling of particles, deposition and erosion (for suspended sediments)
** sources and sinks
** sinks with immediate return inflow at a different location, with optional modification of inflow-temperature as well as -salinity
* turbulence modelling
** constant
** mixing length (various parametrizations)
** two-equation model (turbulent kinetic energy, generic length scale)

'''Primary Computational Results'''

* free surface elevation
* bottom bathymetry and bed evolution rate
* current velocity
* concentration of substances (salinity, temperature, suspended load, tracers)
* turbulent kinetic energy and turbulent length scale
* hydrodynamic pressure

|inputfiles=
# general '''input data''' (filetype [[UNTRIM2.DAT|untrim2.dat]])
# all other input data are described in the aforementioned input file as well as in the further used steering files listed there.
|outputfiles=
# all output data files are either described with filteype [[UNTRIM2.DAT|untrim2.dat]] or with all other filteypes used in the aforementioned master input file. See also [[CF-NETCDF.NC|cf-netcdf.nc]] and [[WAQ-files]].
# printer file with informations on program execution (filetype untrim2.master.sdr).
# (optional) trace file (filetype untrim2.trc).
|methodology=
-
|preprocessor=
[[CREATE_SIMPLE_UNTRIM2_GRID]], [[DATACONVERT]], [[UTRPRE]], [[UTRRND]]
|postprocessor=
[[ABDF]], [[DAVIT]], [[GVIEW2D]], [[LQ2PRO]], [[NCAGGREGATE]], [[NCANALYSE]], [[NCAUTO]], [[NCCHUNKIE]], [[NCCUTOUT]], [[NCDELTA]], [[NCPLOT]], [[NCVIEW2D]], [[NC2TABLE]], [[QUICKPLOT]], [[VVIEW2D]], [[ZEITR]]
|language=Fortran90
|add_software= -
|contact_original=[mailto:info.hamburg@baw.de V. Casulli], [mailto:guenther.lang@baw.de G. Lang]
|contact_maintenance=[mailto:elisabeth.rudolph@baw.de E. Rudolph], [mailto:aissa.sehili@baw.de A. Sehili], [mailto:holger.weilbeer@baw.de H. Weilbeer]
|documentation=
* please refer to $PROGHOME/examples/untrim2009/
}}

UNTRIM

2020-02-25T14:14:05Z

Ak3rhage:

{{ProgramDescription
|name_de=UNTRIM
|name=UNTRIM
|version=2.x / April 2005
|version_descr=November 2013
|catchwords=
numerical simulation 
finite difference method 
finite volume method 
unstructured orthogonal grid 
two-dimensional, three-dimensional 
unsteady, non-linear 
hydrostatic, non-hydrostatic 
reynoldsaveraged Navier Stokes equations (RANS) 
tidal dynamics (long waves) 
wave propagation (short waves, wave spectrum) 
transport of conservative tracers (salt, temperature, suspended sediments) 
numerical method UNTRIM 
morphodynamic sub-model SEDIMORPH 
portable SMP-programming using [http://openmp.org/wp/ OpenMP] 
|shortdescription=
'''Method'''

The three-dimensional finite difference / finite volume [[Mathematical Model UNTRIM|numerical model UNTRIM]] can be used to simulate flow and transport processes in different free-surface flow problems. In contrast to conventional finite difference methods UnTRIM is able to operate on an unstructured orthogonal grid.

'''Physical Processes'''

The following physical processes are currently taken into account by UNTRIM:

* reynoldsaveraged Navier-Stokes equations (RANS)
** local acceleration (inertia)
** advective acceleration
** Coriolis acceleration
** barotropic pressure gradient
** baroclinic pressure gradient
** hydrostatic or non-hydrostatic pressure
** horizontal turbulent viscosity
** vertical turbulent viscosity influenced by density stratification
** bottom friction
** wind friction
** sources and sinks
* transport of tracers
** local rate of change of concentration
** advective rate of change of concentration
** optional flux limiter : Minmod, van Leer or Superbee
** horizontal turbulent diffusivity
** vertical turbulent diffusivity influenced by density stratification
** settling of particles, deposition and erosion (for suspended sediments)
** sources and sinks
** sinks with immediate return inflow at a different location, with optional modification of inflow-temperature as well as -salinity

'''Computational Results'''

* free surface elevation
* current velocity
* concentration of tracers (e.g. salinity, temperature, suspended load)
* vertical turbulent eddy-viscosity
* hydrodynamic pressure
* water density

If a three-dimensional simulation is carried through the depth-averaged results are also computed in addition to the three-dimensional ones.

'''Validation Document'''

A PDF-version of the validation document is freely available for download:

* (approx. 1.2 MB) [http://www.baw.de/downloads/wasserbau/mathematische_verfahren/pdf/vd-untrim-2004.pdf UNTRIM standard validation document]

additional physical sub-models
The numerical method UnTRIM is coupled to the following (independent) physical sub-models:

# morphodynamic computational package SediMorph: for details please refer to [[SEDIMORPH.DAT|sedimorph.dat]].
# spectral wave model k-model: for details please refer [[K_MODEL.DAT|k_model.dat]]
|inputfiles=
# '''main input data''' (filetype [[UNTRIM_MAIN.DAT|untrim_main.dat]]).
# '''Hydrodynamics and Salt Transport''' (filetype [[UNTRIM_HYD.DAT|untrim_hyd.dat]]);
# '''Atmosphere''' (filetype [[UNTRIM_ATM.DAT|untrim_atm.dat]]);
# '''Bedload-Transport''' (filetype [[UNTRIM_BED.DAT|untrim_bed.dat]]);
# '''Equation of State''' (filetype [[UNTRIM_EQS.DAT|untrim_eqs.dat]]);
# '''Morphodynamic Evolution''' (filetype [[UNTRIM_MOR.DAT|untrim_mor.dat]]);
# '''Suspended Sediment Transport''' (filetype [[UNTRIM_SUS.DAT|untrim_sus.dat]]);
# '''Wind Waves''' (filetype [[UNTRIM_WAV.DAT|untrim_wav.dat]]).

'''Notice''': further input files can be found on the file description pages of the aforementioned files.
|outputfiles=
the number and type of result files does mainly depend on the output parameters chosen for the different physical sub models. Typically the following types of files will be generated:

# file with '''modified computational grid''' (filetype [[UNTRIM_GRID.DAT|untrim_grid.dat]]);
#: '''Notice''': this (modified) system file must be used during postprocessing of computational results in the overall domain;
# (optional) file with '''modified profile topography''' (filetype [[PROFIL05.BIN|profil05.bin]]);
#: '''Notice''': this (modified) profile topography must be used during postprocessing of computational results along profiles;
# (optional) '''system file for specific locations''' (filetype [[LOCATION_GRID.DAT|location_grid.dat]]);
#: '''Notice''': this system file must be used for postprocessing of results generated for specific locations.
# (optional) '''computational results''' for the overall domain, at specific locations or along profiles (filetype [[DIRZ.BIN.R|dirz.bin.r]], [[DIRZ.BIN.I|dirz.bin.i]] and [[DIRZ.BIN|dirz.bin]]);
# (optional) '''restart files''', which are necessary for a later continuation of the simulation (filetype [[DIRZ.BIN.R|dirz.bin.r]], [[DIRZ.BIN.I|dirz.bin.i]] and [[DIRZ.BIN|dirz.bin]]);
# (optional) informative '''printer file''' (Dateityp untrim_main.sdr);
# (optional) '''trace of program execution''' (filetype untrim_main.trc).
# message file (filetype untrim.msg); parts of this file can be visualised and processed using [[UNTRIMMONITOR]].
|methodology=
please refer to documentation/literature
|preprocessor=
[[GRIDCONVERT]], [[GVIEW2D]], [[JANET]], [[RSMERGE]], [[TICLQ2]], [[TOUTR]], [[UTRRND]]
|postprocessor=
[[ABDF]], [[ADCP2PROFILE]], [[DIDAMERGE]], [[DIDAMINTQ]], [[DIDAMINTZ]], [[DIDARENAME]], [[DIDASPLIT]], [[ENERF]], [[GRIDCONVERT]], [[GVIEW2D]], [[HVIEW2D]], [[IO_VOLUME]], [[LQ2PRO]], [[NCVIEW2D]], [[PARTRACE]], [[PGCALC]], [[PLOTPROFILZEIT]], [[PLOTTS]], [[QUICKPLOT]], [[RSMERGE]], [[TIMESHIFT]], [[UNS]], [[UNTRIMMONITOR]], [[VTDK]], [[VVIEW2D]], [[XTRDATA]], [[XTRLQ2]], [[ZEITR]]
|language=Fortran90
|add_software= -
|contact_original=[mailto:info.hamburg@baw.de V. Casulli]
|contact_maintenance=[mailto:elisabeth.rudolph@baw.de E. Rudolph], [mailto:holger.weilbeer@baw.de H. Weilbeer]
|documentation=
* please refer to $PROGHOME/examples/untrim/
** '''./BSP_becken_src_snk/''' : example files for a closed basin with one sink and one source.
** '''./BSP_becken_wind/''' : example files for wind influence on water level elevation and current velocity in a closed basin.
** '''./BSP_hafen/''' : example files for wave propagation in a harbour basin.
** '''./BSP_kanal_w_gradient/''' : example files for a straight channel with constant water level gradient;
** '''./BSP_kanal_w_inflow/''' : example files for a straight channel with constant inflow (discharge).
** '''./BSP_kanal_salt_heat/''' : example files for a straight channel with outtake-inflow situation, additionally taking alterations of inflow-temperature and -salinity into account.
** '''./BSP_soliton /''' : propagation of a solitary wave in a straight wave channel.
* [http://www3.interscience.wiley.com/journal/69502070/abstract Casulli, Vincenzo and Roy A. Walters (2000)], An unstructured, three-dimensional model based on the shallow water equations, International Journal for Numerical Methods in Fluids 2000, 32: 331 - 348.
* see also [[Mathematical Model UNTRIM|numerical model UNTRIM]].
}}

NCVIEW2D

2020-02-25T14:13:09Z

Ak3rhage:

{{ProgramDescription
|name_de=NCVIEW2D
|name=NCVIEW2D
|version=Febuary 2020
|version_descr=Febuary 2020
|catchwords=oostprozessor 
time series 
[[CF-NETCDF.NC|cf-netcdf.nc]]

|shortdescription=
[[NCVIEW2D]] is applied to visualize [[CF-NETCDF.NC|cf-netcdf.nc]] data as time series. The following objects are within a plot:

# plot window(s) (also subplots)
# y-axis
# data

A plot window can also have two y-axis with 5 individual data sets each. E. g. plot window 1 and its y-axis 1 can contain the measured and modeled water level, while plot window 2 could show measured salinity on the left y-axis and discharge on the right y-axis.
Plot windows are placed from north to south. Below the lowes window, the UUID of the [[CF-NETCDF.NC|cf-netcdf.nc]] data may be displayed as legend.

<gallery>
Time series.example 1.de.png|example 1
Time series.example 2.en.png|example 2
Time series.example 3.en.png|example 3
</gallery>

|Remarks=
# Variable names can be obtained via ncdump -h myData.nc
# Measurements from [[BOEWRT]] can be converted to [[CF-NETCDF.NC|cf-netcdf.nc]] using [[DATACONVERT]] or [[BOE2NC]]
# Only the last y-label/y-limit of a figure and an axis is used for visualization
# The maximum number of plot windows is 3.
# This project took advantage of netCDF software developed by UCAR/Unidata ([http://www.unidata.ucar.edu/software/netcdf/ Link]).

|inputfiles=
# req: [[NCVIEW2D.DAT]]

|outputfiles=
# [[MATLAB]] figure *.fig
# [[DMQS]] metadata (stored in figure)
# program log *.sdr
# errors and warning *.err
# opt: other formats such as *.jpg, *.tif, *.svg, *.pdf, *.png

|methodology=
This program was written in [[MATLAB]] and takes advantage of existing PROGHOME methods, such as unit conversion or i/o of [[BOEWRT]] data. The program is subdivided in the following sections:

# Reading and checking the steering file
# Testing of the existence of input data and its variables
# Testing of the plausibility of input parameters
# Extracting optional parameters, which have been given in [[NCVIEW2D.DAT]], other data is set to a default value.
# Data import (file, variables)
# Testing of existence of x-axis limits
# Initialising the figure environment
# Initialising the the axis
# Initialising the the legend
# Initialising the UUID legend (if requested)
# Initialising the figure title (if requested)
# Initialising the figure box and grid lines (if requested)
# Initialising the textboxes (if requested)
# Writing [[DMQS]] information in *.fig
# Export *.fig
# Export further formats (if requested)

|preprocessor=[[UNTRIM]], [[UNTRIM2]], [[UNK]], [[DATACONVERT]], [[BOE2NC]], [[NCDELTA]]
|postprocessor=[[MATLAB]]
|language=MATLAB r2019b
|add_software= keine
|contact_original=[mailto:robert.hagen@baw.de R. Hagen]
|contact_maintenance=[mailto:robert.hagen@baw.de R. Hagen]

|documentation=
* Template Files:
** template files available in '''$PROGHOME/examples/ncdelta'''
}}

File:Time series.example 3.en.png

2020-02-25T14:12:36Z

Ak3rhage:

File:Time series.example 2.en.png

2020-02-25T14:12:17Z

Ak3rhage:

File:Time series.example 1.de.png

2020-02-25T14:12:02Z

Ak3rhage:

NCVIEW2D

2020-02-25T14:11:23Z

Ak3rhage: Created page with "{{ProgramDescription |name_de=NCVIEW2D |name=NCVIEW2D |version=Febuary 2020 |version_descr=Febuary 2020 |catchwords=oostprozessor time series CF-NETCDF.NC|cf-net..."

{{ProgramDescription
|name_de=NCVIEW2D
|name=NCVIEW2D
|version=Febuary 2020
|version_descr=Febuary 2020
|catchwords=oostprozessor 
time series 
[[CF-NETCDF.NC|cf-netcdf.nc]]

|shortdescription=
[[NCVIEW2D]] is applied to visualize [[CF-NETCDF.NC|cf-netcdf.nc]] data as time series. The following objects are within a plot:

# plot window(s) (also subplots)
# y-axis
# data

A plot window can also have two y-axis with 5 individual data sets each. E. g. plot window 1 and its y-axis 1 can contain the measured and modeled water level, while plot window 2 could show measured salinity on the left y-axis and discharge on the right y-axis.
Plot windows are placed from north to south. Below the lowes window, the UUID of the [[CF-NETCDF.NC|cf-netcdf.nc]] data may be displayed as legend.

<gallery>
Time series.example 1.de.png|Beispiel 1
Time series.example 2.en.png|Beispiel 2
Time series.example 3.en.png|Beispiel 3
</gallery>

|Remarks=
# Variable names can be obtained via ncdump -h myData.nc
# Measurements from [[BOEWRT]] can be converted to [[CF-NETCDF.NC|cf-netcdf.nc]] using [[DATACONVERT]] or [[BOE2NC]]
# Only the last y-label/y-limit of a figure and an axis is used for visualization
# The maximum number of plot windows is 3.
# This project took advantage of netCDF software developed by UCAR/Unidata ([http://www.unidata.ucar.edu/software/netcdf/ Link]).

|inputfiles=
# req: [[NCVIEW2D.DAT]]

|outputfiles=
# [[MATLAB]] figure *.fig
# [[DMQS]] metadata (stored in figure)
# program log *.sdr
# errors and warning *.err
# opt: other formats such as *.jpg, *.tif, *.svg, *.pdf, *.png

|methodology=
This program was written in [[MATLAB]] and takes advantage of existing PROGHOME methods, such as unit conversion or i/o of [[BOEWRT]] data. The program is subdivided in the following sections:

# Reading and checking the steering file
# Testing of the existence of input data and its variables
# Testing of the plausibility of input parameters
# Extracting optional parameters, which have been given in [[NCVIEW2D.DAT]], other data is set to a default value.
# Data import (file, variables)
# Testing of existence of x-axis limits
# Initialising the figure environment
# Initialising the the axis
# Initialising the the legend
# Initialising the UUID legend (if requested)
# Initialising the figure title (if requested)
# Initialising the figure box and grid lines (if requested)
# Initialising the textboxes (if requested)
# Writing [[DMQS]] information in *.fig
# Export *.fig
# Export further formats (if requested)

|preprocessor=[[UNTRIM]], [[UNTRIM2]], [[UNK]], [[DATACONVERT]], [[BOE2NC]], [[NCDELTA]]
|postprocessor=[[MATLAB]]
|language=MATLAB r2019b
|add_software= keine
|contact_original=[mailto:robert.hagen@baw.de R. Hagen]
|contact_maintenance=[mailto:robert.hagen@baw.de R. Hagen]

|documentation=
* Template Files:
** template files available in '''$PROGHOME/examples/ncdelta'''
}}