Below we list the metadata '''required''' in a NetCDF data file, as well as the optional meta data we '''highly recommend''' that are included with the data set.
'''In progress''' <br>
The parameter names should be used as listed (attention to underscores). The descriptions are example text or several options that are available for that parameter.
Line 71:
Line 72:
| diss_ratio_limit || non-dimensional, if absent the dissipation ration QC-flag is not set. Typically, 2.77.
| diss_ratio_limit || non-dimensional, if absent the dissipation ration QC-flag is not set. Typically, 2.77.
|-
|-
| despike_shear_limit || non-dimensional, if absent the de-spike fraction QC-flag is not set. Typically, 0.05.
| despike_shear_fraction_limit || non-dimensional, if absent the de-spike fraction QC-flag is not set. Typically, 0.05.
|-
|-
| despike_shear_pass_limit || non-dimensional, if absent the de-spike passes QC-flag is not set. Typically 8.
| despike_shear_pass_limit || non-dimensional, if absent the de-spike passes QC-flag is not set. Typically 8.
|-
| f_limit || upper limit to exclude frequencies that have contaminations. Typically infinity.
|-
| fit_2_isr || dissipation threshold to use the method of fitting to the inertial subrange. Typically 10-5 W/kg.
|-
|-
|area || e.g., Arctic Ocean, Barents Sea
|area || e.g., Arctic Ocean, Barents Sea
Revision as of 08:44, 28 August 2023
Below we list the metadata required in a NetCDF data file, as well as the optional meta data we highly recommend that are included with the data set.
The parameter names should be used as listed (attention to underscores). The descriptions are example text or several options that are available for that parameter.
Required Metadata
Parameter Name
Description
title
e.g., Vertical micostructure profiler data from cruise XXX
summary
required by ACDD
comment
required by CF
platform_type
research vessel, sub-surface glider etc
creation_time
yyyy-mm-ddTHH:MM:SSZ
date_created
yyyy-mm-ddTHH:MM:SSZ
date_update
yyyy-mm-ddTHH:MM:SSZ
time_reference_year
year for time reference
fs_fast
sampling frequency for fast channels
fs_slow [math]\displaystyle{ ^a }[/math]
sampling frequency for slow channels
profiling_direction
horizontal, vertical, glide
fft_length
as data points (note, fft_lengths_sec in seconds is optional)
diss_length
as data points
overlap
as data points
goodman
0=not applied; 1=applied
HP_cut
the high-pass filter cutoff frequency in Hz. Can be zero for no filtering.
conventions
CF-1.6, ACDD-1.3, ATOMIX
history
Version 1
data_mode
D #(D)elayed
[math]\displaystyle{ ^a }[/math] or fast_ctd or similar if such records are included
Optional Metadata
Parameter Name
Description
fft_length_sec
seconds
diss_length_sec
seconds
overlap_sec
seconds
f_AA
Hz, the anti-aliasing frequency.
FOM_limit
non-dimensional, if absent the FOM QC-flag is not set. Typically, 1.1.
diss_ratio_limit
non-dimensional, if absent the dissipation ration QC-flag is not set. Typically, 2.77.
despike_shear_fraction_limit
non-dimensional, if absent the de-spike fraction QC-flag is not set. Typically, 0.05.
despike_shear_pass_limit
non-dimensional, if absent the de-spike passes QC-flag is not set. Typically 8.
f_limit
upper limit to exclude frequencies that have contaminations. Typically infinity.
fit_2_isr
dissipation threshold to use the method of fitting to the inertial subrange. Typically 10-5 W/kg.
area
e.g., Arctic Ocean, Barents Sea
geospatial_lat_min
geospatial_lat_max
geospatial_lon_min
geospatial_lon_max
geospatial_vertical_min
0
geospatial_vertical_max
in m
geospatial_vertical_positive
down, up
time_coverage_start
yyyy-mm-ddTHH:MM:SSZ
time_coverage_end
yyyy-mm-ddTHH:MM:SSZ
institution
principal_investigator
authors
contact
project_name
cruise
vessel
source
From the SeaVoX Platform Categories vocabulary (L06) list, e.g. “subsurface mooring”, ”ship”, ""sub-surface gliders"", ""autonomous underwater vehicle"" (CF)