Data Submission Special Requirements
When preparing a submission, check to see if the data type is in the list below. Certain types of SeaBASS data submissions have special requirements. For example, some data files need conditionally required metadata headers, and some submissions require extra "checklist" documents. These requirements and several examples are listed below, sorted by data types. This list is growing and evolving and more data types will be added in the future.
Check if your submission type lists any required extra documents. These checklists are designed to standardize and preserve critical methods and analysis details that are needed for intercomparison, reprocessing, to make it easier for data users to assess the data quality and to consider them for satellite validation or inclusion in algorithm development datasets. We prefer you submit a plain text (.txt) document, but if multiple format versions are offered (e.g., rich text and plain text), pick your preference and fill out the necessary sections. Rename the file in a relevant way to make it unique (e.g., add the cruise name to the end of the file name), and add it to the other documents and calibration files that are part of your submission.
The special notes section for each data type highlights any necessary measurement-specific metadata (e.g., conditionally required headers), fields, or formatting.
This page also provides example submission sections containing model data files and documentation bundles to help you format different types of submissions. These files were picked from the archive or created to serve as references. Your files might look a bit different, but hopefully the examples are helpful as a starting place from which to further adapt or improve as needed.
Submission Instructions
Metadata Headers
This page provides an overview of the standardized metadata headers used in the SeaBASS (.sb) file format. Metadata headers preserve critical metadata and enable data organization and discoverability. Below is a brief general description of header formatting rules, followed by a comprehensive list and definition of standardized metadata keywords.
General Header Formatting Rules:
- Required Start and End Tags: The block must begin with
/begin_headerand close with/end_header. The headers between them can be in any order. - Keyword-Value Pairs: Most headers consist of a keyword (from the standardized lists below) paired with value(s).
- Example:
/delimiter=comma
- Example:
- No Spaces Allowed: Headers must not contain whitespace. Use underscores (
_) rather than spaces.- Multiple values: If listing multiple values, comma-separate them without spaces (e.g.,
/investigators=John_Smith,Mary_Miller). - Exception: Freeform comments begin with
!and may contain whitespace (e.g.,! This is a comment).
- Multiple values: If listing multiple values, comma-separate them without spaces (e.g.,
- Handling Missing Header Values: If a required metadata value is unavailable, use NA (Not Applicable). (Note: Do not use NA in the Data Matrix; use your defined numeric
/missingvalue instead). - Bracketed Units: Do not use bracketed units in headers, with the sole exception of time and location headers (e.g.,
[GMT] and [DEG]). All other units are implied by the SeaBASS standard metadata headers dictionaries. - Time and Location Ranges: The date, time, and location headers must reflect the minimum and maximum bounds of the file (e.g., the earliest time, the farthest north latitude).
- Experiment and Cruise Names: Use consistent names if submitting to an existing project. New names should be selected thoughtfully. These names are very important for data organization and for grouping related datasets. Note: The experiment name is critical as it becomes part of the assigned Digital Object Identifier (DOI).
Header Categories: Many keyword headers are mandatory. However, not all headers are treated equally when creating .sb files:
- Required: Must be included in every SeaBASS file.
- Conditionally Required: Must be included for specific types of measurements.
- Optional: Should be included if relevant, but not required.
- Comments: Freeform comments may be included as lines beginning with
!.
Additional information and a full example can be found below.
FCHECK
Plankton and Particles Flow Cytometry
The guidelines presented below will assist the user in submitting flow cytometry data to SeaBASS. The format described herein allows for Level 2 submissions of flow cytometry data, meaning sums of total abundances of each phytoplankton or bacterial group. Specific metadata headers and field names have been developed for these data. Additionally, detailed instructions are given for the submission of documentation (protocol document, checklist, etc.), images, and additional ancillary files. Greater detail regarding the development and application of these guidelines and requirements can be found in Neeley et al., 2023.
Neeley, A.R., Soto-Ramos, I. and Proctor, C. (2023) Standards and Best Practices for Reporting Flow Cytometry Observations: a technical manual, Version 1.1. Greenbelt, MD., NASA Goddard Space Flight Center, 31pp. DOI: http://dx.doi.org/10.25607/OBP-1864.2.
readsb (Python)
SeaBASS Software Tools
Standardized Fields and Units
Below is a table of the standard field names and associated units for use in submitting data to the SeaBASS bio-optical archive. The field names are not case sensitive. Use the search bar or the find function in your browser to search the table for words or patterns found in the field names, units or descriptions. Please contact SeaBASS staff if you want to discuss adding new fields.
Special notes regarding wavelength-specific measurements: There are two different ways to indicate wavelengths (nm) in a SeaBASS file. If metadata such as date, location, or depth vary within the data, then append the wavelength number to the field name for every measurement combination. For example, downwelling irradiance ('Ed') measured at 412.3 nm is 'Ed412.3' (listed as separate columns alongside other Ed measurements, like Ed416.2, Ed419, etc.) Alternately, if date, location, and depth are assumed to be approximately constant for all measurements in the file, then use the field 'wavelength' to provide a column of the measured wavelengths and don't include them as part of the field names (this pivoted layout is commonly used for reporting spectrophotometric measurements or other measurements that use the data_type=scan keyword).
Two additional tables are provided below (Field Name Suffixes & Modifiers). The reusable naming conventions in those tables are used to create new field names without having to add dozens or hundreds of variations to the Table of Field Names and Units. For example, "_sd" (for standard deviation) appears in the table of suffixes and may be appended to any existing SeaBASS field name (e.g., "chl_sd" or "Rrs510_sd".) Similarly, field-specific names can be created ad infinitum using _bincount (i.e., number of averaged samples), and _quality. The table of modifiers allows extra information to be part of field names, typically to indicate versions of measurements that are either more specific or modified. For example, modifiers are used to denote size-fractionated measurements (see _#umfilt and _#umprefilt), specific excitation or emission wavelengths, or polarized measurements. Field names may be constructing by combing entries from multiple tables, with any applicable wavelength first, followed by "Modifiers", followed by a "Suffix".
Plankton and particles imagery (IFCB, UVP)
The guidelines presented below will assist the user in submitting imaging-in-flow or submersible microscopic data to SeaBASS. Specific metadata headers and field names have been developed for plankton and other particle data. Additionally, detailed instructions are given for the submission of documentation (protocol document, checklist, etc.), images, and additional ancillary files. The submitter must indicate in the checklist whether all ROIs in a sample were annotated. Greater detail regarding the development and application of these guidelines and requirements can be found in Neeley et al., 2021.