Netcdf meta data (shear probes): Difference between revisions

From Atomix
← Older edit
VisualWikitext
required data table in sync with data descriptor paper
KikiSchulz (talk | contribs)
107 edits
 
(8 intermediate revisions by 3 users not shown)
Line 10: Line 10:
{| class="wikitable sortable"
{| class="wikitable sortable"
|-
|-
! Parameter Name !! Description
! Attibute Name !! Description !! Convention
|-
|-
|title || e.g., Vertical micostructure profiler data from cruise XXX
|title || A comprehensive title for the dataset including the time and location aspect || CF, ACDD
|-
|-
|authors ||  Names of authors
|authors ||  A list of authors || ATOMIX
|-
|-
|summary || An abstract describing the dataset  
|summary || An abstract describing the dataset || ACCD
|-
|-
|comment|| Supplementary technical details about the collecting and processing of the dataset  
|comment|| Supplementary technical details about the collecting and processing of the dataset || CF, ACDD
|-
|-
|platform_type || The platform from which the data are collected. From the SeaVoX Platform Categories (L06) list,
|platform_type || The platform from which the data are collected, e.g., sub-surface mooring, research vessel, sub-surface glider || ACDD
e.g. sub-surface mooring, research vessel, sub-surface glider
|-
|-
|source || The instrument used for collecting the data. For example, vertical microstructure profiler, VMP2000 SN009.
|source || The instrument used for collecting the data. For example, vertical microstructure profiler, VMP2000 SN009 || CF, ACDD
|-
|-
|date_created || The date on which the data was created, yyyy-mm-ddTHH:MM:SSZ
|date_created || The date on which the data were created, yyyy-mm-ddTHH:MM:SSZ || ACDD
|-
|-
|date_update || The date on which the data was last modified, yyyy-mm-ddTHH:MM:SSZ  
|date_modified || The date on which the data were last modified, yyyy-mm-ddTHH:MM:SSZ || ACDD
|-
|-
|time_reference_year || Year for time reference
|time_reference_year || Year for time reference || ATOMIX
|-
|-
|time_coverage_start || Time of the first data point in the dataset, yyyy-mm-ddTHH:MM:SSZ
|time_coverage_start || Time of the first data point in the dataset, yyyy-mm-ddTHH:MM:SSZ || ACDD
|-
|-
|time_coverage_end || Time of thelast data point in the dataset, yyyy-mm-ddTHH:MM:SSZ
|time_coverage_end || Time of thelast data point in the dataset, yyyy-mm-ddTHH:MM:SSZ ||ACDD
|-
|-
|geospatial_lat_min || Southern bound of data, decimal degrees, negative for South
|geospatial_lat_min || Southern bound of data, decimal degrees, negative for South || ACDD
|-
|-
|geospatial_lat_max || Northern bound of data, decimal degrees, negative for South
|geospatial_lat_max || Northern bound of data, decimal degrees, negative for South || ACDD
|-
|-
|geospatial_lon_min || Western bound of data, decimal degrees, negative for West
|geospatial_lon_min || Western bound of data, decimal degrees, negative for West || ACDD
|-
|-
|geospatial_lon_max || Eastern bound of data, decimal degrees, negative for West
|geospatial_lon_max || Eastern bound of data, decimal degrees, negative for West || ACDD
|-
|-
| fs_fast || Sampling frequency for fast (turbulence) channels
| fs_fast || Sampling frequency for fast (turbulence) channels || ATOMIX
|-
|-
| fs_slow <math>^a</math> || Sampling frequency for slow channels (if exist)
| fs_slow <math>^a</math> || Sampling frequency for slow channels (if exists). Alternative names could be, e.g., fs_CTD || ATOMIX
|-
|-
| profiling_direction || E.g., horizontal, vertical, or glide
| profiling_direction || Direction along which the section was collected, e.g., horizontal, vertical, or glide || ATOMIX
|-
|-
| fft_length ||  Length of the Fast Fourier transform segments (in data points; note, fft_lengths_sec in seconds is optional)
| fft_length ||  Length of the Fast Fourier transform segments (in data points; note, fft_lengths_sec in seconds is optional) || ATOMIX
|-
|-
| diss_length  || Length of data (in data points) used for each dissipation estimate
| diss_length  || Length of data (in data points) used for each dissipation estimate || ATOMIX
|-
|-
| overlap ||  Length of overlap (in data points) in diss_length
| overlap ||  Length of overlap (in data points) in diss_length || ATOMIX
|-
|-
| goodman  || Vibration coherent noise removal using the Goodman algorithm. 0=not applied; 1=applied
| goodman  || Flag for the vibration coherent noise removal using the Goodman algorithm. 0=not applied; 1=applied || ATOMIX
|-
|-
| HP_cut  || The high-pass filter cutoff frequency in Hz. Can be zero for no filtering.
| HP_cut  || The high-pass filter cutoff frequency in Hz. Can be zero for no filtering. || ATOMIX
|-
|-
| conventions || A comma-separated list of the conventions that are followed by the dataset. e.g., CF-1.6, ACDD-1.3, ATOMIX
| conventions || A comma-separated list of the conventions that are followed by the dataset. e.g., CF-1.6, ACDD-1.3, ATOMIX || CF, ACDD
|-
|-
| history || Provides an audit trail for modifications to the original data; e.g., Version 1
| history || Provides an audit trail for modifications to the original data; e.g., Version 1 || CF, ACDD
|-
| data_mode ||  D (D)elayed
|}
|}
<math>^a</math> or fast_ctd or similar if such records are included
It is highly recommended to duplicate relevant attributes at the corresponding
group level. Attributes not listed in the Climate and Forecast (CF) and the Attribute Convention for Data Discovery (ACDD)
standards are labeled as ATOMIX.
</div>
</div>


Line 73: Line 72:
{| class="wikitable sortable"
{| class="wikitable sortable"
|-
|-
! Parameter Name !! Description
! Attribute Name !! Description !! Convention
|-
| fft_length_sec ||  seconds
|-
| diss_length_sec  || seconds
|-
| overlap_sec ||  (for diss_length_sec) seconds
|-
|-
| f_AA ||  Hz, the anti-aliasing frequency.
| fft_length_sec ||  Length of the Fast Fourier transform segments in seconds || ATOMIX
|-
|-
| FOM_limit || non-dimensional, if absent the FOM QC-flag is not set. Typically, 1.15.
| diss_length_sec  || Dissipation estimate data length in seconds || ATOMIX
|-
|-
| diss_ratio_limit ||  non-dimensional, if absent the dissipation ration QC-flag is not set. Typically, 2.77.
| overlap_sec ||  Length of overlap (in seconds) in diss_length_sec || ATOMIX
|-
|-
| despike_shear_fraction_limit ||  non-dimensional, if absent the de-spike fraction QC-flag is not set. Typically, 0.05.
| f_AA ||  The anti-aliasing frequency in Hz || ATOMIX
|-
|-
| despike_shear_iterations_limit ||  non-dimensional, if absent the de-spike iteration passes QC-flag is not set. Typically 8.
| FOM_limit ||  Figure of merit limit for quality assurance. Typically between 1.15 and 1.4. || ATOMIX
|-
|-
| variance_resolved_limit ||  threshold for the minimum percent of variance resolved in a shear spectrum. Typically 50%.
| diss_ratio_limit ||  The limit to identify anomalously large disagreement between dissipation estimates from probes. The magnitude of the difference of the natural logarithm of two dissipation estimates should be smaller than diss_ratio_limit <math>\times \sigma_{\ln \varepsilon}</math>. Typically, 2.77. || ATOMIX
|-
|-
| spectral_model || e.g., Nasmyth, Lueck or Panchev-Kesich
| despike_shear_fraction_limit || The maximum allowed fraction of data (of each diss_length_sec length) removed by de-spiking. Typically, 0.05. || ATOMIX
|-
|-
| spectrum_std  || statistical uncertainty (standard deviation) of the natural logarithm of spectrum of shear
| despike_shear_iterations_limit || The maximum number of allowed iterations of de-spiking when producing the L2 shear probe data (one value per section). Typically 8. || ATOMIX
|-
|-
| num_vibration_goodman || number of vibration or acceleration time series used to clean the shear spectrum
| variance_resolved_limit || The minimum fraction of variance resolved in an estimate by spectral integration. Typically 0.6. || ATOMIX
|-
|-
| f_limit || upper limit to exclude frequencies that have contaminations. Typically infinity.
| f_limit || The upper limit to exclude frequencies from analysis. Typically infinity. || ATOMIX
|-
|-
| fit_2_isr || dissipation threshold to use the method of fitting to the inertial subrange. Typically 10-5 W/kg.
| fit_2_isr || Dissipation threshold for using the method of fitting in the inertial subrange. Typically <math>10^{−5}</math> W kg<math>^{−1}</math>. || ATOMIX
|-
|-
|eps_remove_top_meters || if applicable, upper meters removed from dissipation estimates (e.g., because of ship)
| spectral_model || The model shear spectrum used in dissipation estimates with the integration method: e.g., Nasmyth, Lueck or Panchev-Kesich || ATOMIX
|-
|-
|area ||         e.g., Arctic Ocean, Barents Sea
|area || The region where the data were collected, e.g., Arctic Ocean, Barents Sea || ATOMIX
|-
|-
|geospatial_vertical_min|| 0
|geospatial_vertical_min|| Further refinement of the geospatial bounding box. Vertical minimum in m || ACDD
|-
|-
|geospatial_vertical_max|| in m
|geospatial_vertical_max|| Further refinement of the geospatial bounding box. Vertical maximum in m || ACDD
|-
|-
|geospatial_vertical_positive|| down, up
|geospatial_vertical_positive|| Direction of positive vertical: down, up || ACDD
|-
|-
|institution ||  e.g. University of Bergen
|institution ||  The name of the institution principally responsible for originating this data || CF, ACDD
|-
|-
|principal_investigator ||  Name of Principal Investigator
|principal_investigator ||  Name of the principal investigator who created the data || ATOMIX
|-
|-
|contact || email address of corresponding author (usually principal investigator)
|contact || Name of the contact person || ACDD
|-
|-
|project_name || name of project for which the data was collected
|project || The scientific project that produced the data || ACDD
|-
|-
|cruise || name of cruise from which the data was collected
|cruise || The name or number of the research cruise || ATOMIX
|-
|-
|vessel || name of vessel from which the data was collected
|vessel || The name of the research vessel || ATOMIX
|-
|-
|source || From the SeaVoX Platform Categories vocabulary (L06) list, e.g.  “subsurface mooring”, ”ship”, ""sub-surface gliders"", ""autonomous underwater vehicle"" (CF)
|references || A list of related references || CF, ACDD
|-
|-
|references || key references
|keywords || A comma-separated list of keywords and phrases || ACDD
|-
|-
|keywords || relevant keywords describing data e.g. shear probes
|creator_name || The data creator’s name || ACDD
|-
|-
|creator_name || name of person who generated the file
|creator_email || The data creator’s email || ACDD
|-
|-
|creator_email || email address of person who generated the file
|creator_url || The data creator’s URL || ACDD
|-
|-
|creator_url || website address of the creator
|acknowledgement|| Acknowledgement of support for the project that produced this data || ACDD
|-
|-
|acknowledgement|| acknowledgements for this data. e.g. this could include crew of ship or funders
|station_name || The name of the station where data were collected || ATOMIX
|-
|-
|station_name ||  name of station
|license ||  Provide the URL to a standard or specific license, e.g, http://creativecommons.org/licenses/by/4.0/, Freely Distributed, or None || ACDD
|}
|}


Latest revision as of 19:51, 24 May 2024


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


Attibute Name Description Convention
title A comprehensive title for the dataset including the time and location aspect CF, ACDD
authors A list of authors ATOMIX
summary An abstract describing the dataset ACCD
comment Supplementary technical details about the collecting and processing of the dataset CF, ACDD
platform_type The platform from which the data are collected, e.g., sub-surface mooring, research vessel, sub-surface glider ACDD
source The instrument used for collecting the data. For example, vertical microstructure profiler, VMP2000 SN009 CF, ACDD
date_created The date on which the data were created, yyyy-mm-ddTHH:MM:SSZ ACDD
date_modified The date on which the data were last modified, yyyy-mm-ddTHH:MM:SSZ ACDD
time_reference_year Year for time reference ATOMIX
time_coverage_start Time of the first data point in the dataset, yyyy-mm-ddTHH:MM:SSZ ACDD
time_coverage_end Time of thelast data point in the dataset, yyyy-mm-ddTHH:MM:SSZ ACDD
geospatial_lat_min Southern bound of data, decimal degrees, negative for South ACDD
geospatial_lat_max Northern bound of data, decimal degrees, negative for South ACDD
geospatial_lon_min Western bound of data, decimal degrees, negative for West ACDD
geospatial_lon_max Eastern bound of data, decimal degrees, negative for West ACDD
fs_fast Sampling frequency for fast (turbulence) channels ATOMIX
fs_slow [math]\displaystyle{ ^a }[/math] Sampling frequency for slow channels (if exists). Alternative names could be, e.g., fs_CTD ATOMIX
profiling_direction Direction along which the section was collected, e.g., horizontal, vertical, or glide ATOMIX
fft_length Length of the Fast Fourier transform segments (in data points; note, fft_lengths_sec in seconds is optional) ATOMIX
diss_length Length of data (in data points) used for each dissipation estimate ATOMIX
overlap Length of overlap (in data points) in diss_length ATOMIX
goodman Flag for the vibration coherent noise removal using the Goodman algorithm. 0=not applied; 1=applied ATOMIX
HP_cut The high-pass filter cutoff frequency in Hz. Can be zero for no filtering. ATOMIX
conventions A comma-separated list of the conventions that are followed by the dataset. e.g., CF-1.6, ACDD-1.3, ATOMIX CF, ACDD
history Provides an audit trail for modifications to the original data; e.g., Version 1 CF, ACDD

It is highly recommended to duplicate relevant attributes at the corresponding group level. Attributes not listed in the Climate and Forecast (CF) and the Attribute Convention for Data Discovery (ACDD) standards are labeled as ATOMIX.

Optional Metadata


Attribute Name Description Convention
fft_length_sec Length of the Fast Fourier transform segments in seconds ATOMIX
diss_length_sec Dissipation estimate data length in seconds ATOMIX
overlap_sec Length of overlap (in seconds) in diss_length_sec ATOMIX
f_AA The anti-aliasing frequency in Hz ATOMIX
FOM_limit Figure of merit limit for quality assurance. Typically between 1.15 and 1.4. ATOMIX
diss_ratio_limit The limit to identify anomalously large disagreement between dissipation estimates from probes. The magnitude of the difference of the natural logarithm of two dissipation estimates should be smaller than diss_ratio_limit [math]\displaystyle{ \times \sigma_{\ln \varepsilon} }[/math]. Typically, 2.77. ATOMIX
despike_shear_fraction_limit The maximum allowed fraction of data (of each diss_length_sec length) removed by de-spiking. Typically, 0.05. ATOMIX
despike_shear_iterations_limit The maximum number of allowed iterations of de-spiking when producing the L2 shear probe data (one value per section). Typically 8. ATOMIX
variance_resolved_limit The minimum fraction of variance resolved in an estimate by spectral integration. Typically 0.6. ATOMIX
f_limit The upper limit to exclude frequencies from analysis. Typically infinity. ATOMIX
fit_2_isr Dissipation threshold for using the method of fitting in the inertial subrange. Typically [math]\displaystyle{ 10^{−5} }[/math] W kg[math]\displaystyle{ ^{−1} }[/math]. ATOMIX
spectral_model The model shear spectrum used in dissipation estimates with the integration method: e.g., Nasmyth, Lueck or Panchev-Kesich ATOMIX
area The region where the data were collected, e.g., Arctic Ocean, Barents Sea ATOMIX
geospatial_vertical_min Further refinement of the geospatial bounding box. Vertical minimum in m ACDD
geospatial_vertical_max Further refinement of the geospatial bounding box. Vertical maximum in m ACDD
geospatial_vertical_positive Direction of positive vertical: down, up ACDD
institution The name of the institution principally responsible for originating this data CF, ACDD
principal_investigator Name of the principal investigator who created the data ATOMIX
contact Name of the contact person ACDD
project The scientific project that produced the data ACDD
cruise The name or number of the research cruise ATOMIX
vessel The name of the research vessel ATOMIX
references A list of related references CF, ACDD
keywords A comma-separated list of keywords and phrases ACDD
creator_name The data creator’s name ACDD
creator_email The data creator’s email ACDD
creator_url The data creator’s URL ACDD
acknowledgement Acknowledgement of support for the project that produced this data ACDD
station_name The name of the station where data were collected ATOMIX
license Provide the URL to a standard or specific license, e.g, http://creativecommons.org/licenses/by/4.0/, Freely Distributed, or None ACDD

return to Dataset requirements for shear probes

Retrieved from "http://atomix.app.uib.no/index.php?title=Netcdf_meta_data_(shear_probes)&oldid=4615"