NetCDF

General Aspects

Purpose of these BAWiki Pages

These BAWiki pages do describe all NetCDF conventions required to store baw-specific data in NetCDF data files (see network common data form). I. e. all local conventions are listed, which go beyond the international agreed-upon CF-metadata convention. These pages are also meant as a discussion ground for agreeing on those additional conventions required.

In cases where the international agreed-upon conventions are insufficient, one should first check whether extensions described in Deltares-Conventions can be used or not - it is recommended to discuss further required extensions with Deltares. The version which has been recommended to become a standard can be found on the GITHUB. Further activities related with OpenDAP to extract a selection of data defined on unstructured grids can be found on e. g. OPULS.

The additional conventions should be listed in the global NetCDF attribute Conventions, e. g. in the following way:

// global attributes:

:Conventions = "CF-1.4/Deltares-0.1/BAW-0.1" .

The BAW instance of a NetCDF file developed since 2010 is a file of type CF-NETCDF.NC.

Since version NetCDF-4.0 HDF (Hierarchical Data File, see HDF5 Group) is used as the underlying file format. Due to the use of HDF concepts like online compression of data stored in NetCDF files is supported as well as chunking of variables to balance read performance in case of different access to data, e.g. time-series vs. synoptic data set access.

Important NetCDF Utilities

Important (helpful) NetCDF Utilities are:

• NCDUMP create (selective) text representation of the contents of a NetCDF file;
• NCCOPY (selective) copy an existing NetCDF file to another, change level of compression, change internal file structure (File Chunking); and
• NCGEN3 create NetCDF file from a CDL text file; optionally also C or FORTRAN code can be automatically generated.

File Chunking

The chunk size of variables stored in a CF NetCDF file may have significant influence on read performance in case data have to be read along different dimensions, e.g. spatial versus time-series access. Chunk size can be individually tuned using the NetCDF API. As a simple alternative, already helpful in many situations, you can also make use of the NCCOPY program. For further informations about chunking please read the following informations:

• Chunking Data - Why it matters; und
• Chunking Data - Choosing shapes.

Global Attributes

• NetCDF global attributes

Grids

• NetCDF multiple locations: several (point) locations, e. g. equivalent to contents of file location_grid.dat;
• NetCDF multiple profiles: several longitudinal and cross-sectional profiles, e. g. equivalent to contents of file profil05.bin;
• NetCDF triangular grid: triangular grid, e. g. equivalent to contents of file gitter05.dat and gitter05.bin;
• NetCDF unstructured grid: unstructured grid, e. g. equivalent to contents of file untrim_grid.dat;
• NetCDF unstructured grid with subgrid: unstructured grid with additional subgrid data, e. g. equivalent to contents of file utrsub_grid.dat.

Time Coordinate

• NetCDF time coordinate: date and time, calendar.

Vertical Coordinate

• NetCDF vertical coordinate: dimensional vertical coordinate (height, depth).

Horizontal Coordinate Reference System

• NetCDF grid mapping variable

Reduction of Dataset Size

Traditionally, up to the availability of NetCDF-4 (HDF),

• NetCDF packed data, and
• NetCDF compression by gathering

were the only ways to reduce data set sizes. Now, with the availability oaf NetCDF-4 (HDF), it is recommended to use online compression instead. Online compression can be activated on a per variable basis via the NetCDF API. For existing NetCDF files NCCOPY also allows you to (online-) compress the file after it has been created.

Data

Synoptic Data

• NetCDF synoptic data at multiple locations,
• NetCDF synoptic data for multiple profiles,
• NetCDF cross section integral synoptic data for multiple profiles,
• NetCDF synoptic data for triangular grid,
• NetCDF synoptic (morphological) data for triangular grid,
• NetCDF synoptic data for unstructured grid,
• NetCDF synoptic data for unstructured grid with subgrid, and
• NetCDF DelWAQ data.

Analysis Data

• NetCDF tidal characteristic numbers of water level, and
• NetCDF differences for tidal characteristic numbers of water level.

---

back to Standard-Software-Applications (Add-ons)

---

Overview