Getting Started

The OAE Data Protocol

The OAE Data Management Protocol is a set of guidelines for collecting, documenting, and sharing data from ocean alkalinity enhancement research. It covers:

• What metadata to include with your data submissions
• Recommended column header names for data files
• Controlled vocabularies for consistent terminology
• Guidelines for quality control documentation

New to the OAE Data Protocol?

If you're new to the protocol and want to learn about its guidelines and recommendations before diving into the technical schema, start with the protocol website on Carbon To Sea. It includes the full guidelines, controlled vocabularies, and recommended column header names.

The OAE Data Schema

This site is the technical reference for the protocol's machine-readable schema — the formal data model that defines how OAE metadata is structured, validated, and exchanged. Use it to:

• Understand the variable class hierarchy and how to describe different measurement types
• Look up required fields for experiments, datasets, and instruments
• Browse controlled vocabularies used across the protocol
• Reference the full schema index for every class, slot, and enum

The schema generates JSON Schema for validation, Python dataclasses for programmatic access, and a JSON-LD context for linked data compatibility.

Creating Metadata

The easiest way to create metadata is with the OAE Metadata Builder — a web app that walks you through each section and exports a valid JSON file. See the Metadata Builder page for details.

Working with Metadata Files

Metadata files are JSON documents that follow the Container format. You can:

• Create them using the Metadata Builder or programmatically
• Validate them against the JSON Schema
• Import them back into the Metadata Builder for editing
• Submit them alongside your data files

See Metadata File Format for the full specification.