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 ane 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. If multiple download 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.
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".
This page provides general SeaBASS documentation and guidelines, focusing primarly on how submissions should incorporate free-form information in external documents. This page is currently being updated (early 2020) to reflect recent changes, to better clarify certain requirements, and to provide more examples.
SeaBASS submissions have two general types of metadata, 1) self-contained metadata, e.g., machine-readable metadata headers, and text comments and 2) external documents and calibration files.
Self-contained within SeaBASS Data Files
- /documents (REQUIRED, a comma-separated list of the file name(s) of all external documentation)
- /calibration_files (REQUIRED, a comma-separated list of the file name(s) of all of external calibration files)
- Comments (OPTIONAL, text comments may be included in the header. Comment lines must start with an exclamation point. e.g., ! This is a comment)
External Documents and Calibration Files
- Reports documenting all methods
- Data Submission Special Requirements (mandatory forms for certain types of submissions)
- If applicable, instrument calibration files
Documentation needs to be provided that explains all methods, including those related to deployment, sampling, and analysis. Important instrument settings and calibration information must also be retained for traceability. Since it would not be efficient to include all this information within each SeaBASS data file, these data should be provided separately, and referenced via the "documents" and "calibration_files" metadata headers.
Documents and calibration files are not required to be in any special format (i.e., they aren't SeaBASS format, nor do they need to be scanned by FCHECK). For any written reports, PDF or plain text format are preferred.
Special Requirements: Please consult the Data Submission Special Requirements page to see if it includes special guidelines for the types of measurements you wish to submit. The page includes required checklists, required special metadata headers, and example data files. Check back periodically, as new content is added to that page over time to include additional data types and other updates.
These checklists are new to the community as of early 2020. The SeaBASS team welcomes feedback if you have suggestions for improving specific forms, and is interested to hear if you have requests for additional information or topics.