You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: src/docs/files/getting-started/index.md
+3-2Lines changed: 3 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,15 +2,16 @@
2
2
3
3
## The OAE Data Protocol
4
4
5
-
The [OAE Data Management Protocol](https://www.carbontosea.org/oae-data-protocol/1-0-0/) is a set of guidelines for collecting, documenting, and sharing data from ocean alkalinity enhancement research. It covers:
5
+
The [OAE Data Management Protocol](https://www.carbontosea.org/oae-data-protocol) is a set of guidelines for
6
+
collecting, documenting, and sharing data from ocean alkalinity enhancement research. It covers:
6
7
7
8
- What metadata to include with your data submissions
8
9
- Recommended column header names for data files
9
10
- Controlled vocabularies for consistent terminology
10
11
- Guidelines for quality control documentation
11
12
12
13
!!! info "New to the OAE Data Protocol?"
13
-
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](https://www.carbontosea.org/oae-data-protocol/1-0-0/) on Carbon To Sea. It includes the full guidelines, [controlled vocabularies](https://www.carbontosea.org/oae-data-protocol/1-0-0/#controlled-vocabularies), and [recommended column header names](https://www.carbontosea.org/oae-data-protocol/1-0-0/#column-header-name).
14
+
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](https://www.carbontosea.org/oae-data-protocol) on Carbon To Sea. It includes the full guidelines, [controlled vocabularies](https://www.carbontosea.org/oae-data-protocol#controlled-vocabularies), and [recommended column header names](https://www.carbontosea.org/oae-data-protocol#column-header-names).
Copy file name to clipboardExpand all lines: src/docs/files/index.md
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,7 +1,7 @@
1
1
# Schema Documentation
2
2
3
-
The [OAE Data Management Protocol](https://www.carbontosea.org/oae-data-protocol/1-0-0/) outlines recommendations for
4
-
producing consistent data and metadata across Ocean Alkalinity Enhancement research projects, developed by [Carbon To Sea](https://carbontosea.org) and [Submarine Scientific](https://submarine.earth) in collaboration with NOAA and the broader OAE community.
3
+
The [OAE Data Management Protocol](https://www.carbontosea.org/oae-data-protocol) outlines recommendations for
4
+
producing consistent data and metadata across Ocean Alkalinity Enhancement projects, developed by [Carbon To Sea](https://carbontosea.org) and [Submarine Scientific](https://submarine.earth) in collaboration with NOAA and the broader OAE community.
5
5
6
6
This site serves as the technical documentation for the machine-readable schemas that turn those recommendations into something software systems can validate and exchange.
7
7
@@ -20,11 +20,11 @@ The OAE Data Protocol is a structured approach to collecting, documenting, and s
20
20
-**Variables** — Measured, calculated, and contextual variables with instrument and calibration metadata
21
21
22
22
For protocol requirements pertaining to general metadata management, excel metadata templates, dataset formatting, and
23
-
column header names, see the [published protocol](https://www.carbontosea.org/oae-data-protocol/1-0-0/).
23
+
column header names, see the [published protocol](https://www.carbontosea.org/oae-data-protocol).
24
24
25
25
26
26
### Published Artifacts & Resources
27
-
-[OAE Metadata Builder](https://github.com/submarine-mrv/oae-metadata-builder) — Web app for creating and managing JSON metadata files
27
+
-[OAE Metadata Builder](https://metadata.oaedata.org) — Web app for creating and managing JSON metadata files
28
28
-[JSON Schema](https://github.com/submarine-mrv/oae-data-protocol/blob/main/project/jsonschema/oae_data_protocol.schema.json) — Machine readable schemas used for validation
29
29
-[LinkML Source Schema](https://github.com/submarine-mrv/oae-data-protocol/tree/main/src/oae_data_protocol/schema) — The source of truth for generating all schema artifacts and documentation (contributors should only edit these files)
30
30
-[Python Dataclasses](https://github.com/submarine-mrv/oae-data-protocol/blob/main/src/oae_data_protocol/datamodel/oae_data_protocol.py) — For managing metadata directly in Python workflows (WIP)
Copy file name to clipboardExpand all lines: src/docs/files/metadata-format.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,7 +4,7 @@ The OAE Data Protocol uses **JSON** as its preferred metadata file format.
4
4
5
5
Each metadata file is a self-contained document called a **Container** that holds all the metadata for a project, its experiments, and its datasets.
6
6
7
-
The recommended way to create metadata is with the **[OAE Metadata Builder](https://metadata.oaedata.org)**, which validates inputs against the schema in real time and exports well-formed JSON files. While [Excel templates](https://www.carbontosea.org/oae-data-protocol/1-0-0/#metadata-and-templates) are still available on the protocol website, they do not validate against the schema and require manual attention to ensure controlled vocabularies and field formats are correct. We encourage all researchers to use the Metadata Builder as the primary tool for creating and managing project metadata.
7
+
The recommended way to create metadata is with the **[OAE Metadata Builder](https://metadata.oaedata.org)**, which validates inputs against the schema in real time and exports well-formed JSON files. While [Excel templates](https://www.carbontosea.org/oae-data-protocol#metadata-and-templates) are still available on the protocol website, they do not validate against the schema and require manual attention to ensure controlled vocabularies and field formats are correct. We encourage all researchers to use the Metadata Builder as the primary tool for creating and managing project metadata.
Copy file name to clipboardExpand all lines: src/docs/files/vocabularies.md
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,7 +2,7 @@
2
2
3
3
The OAE Data Protocol uses controlled vocabularies to standardize categorical values across metadata submissions. Some are defined as part of the protocol, while others reference established community standards.
4
4
5
-
For detailed definitions of each vocabulary, see the [Controlled Vocabularies](https://www.carbontosea.org/oae-data-protocol/1-0-0/#controlled-vocabularies) section of the OAE Data Protocol website.
5
+
For detailed definitions of each vocabulary, see the [Controlled Vocabularies](https://www.carbontosea.org/oae-data-protocol#controlled-vocabularies) section of the OAE Data Protocol website.
6
6
7
7
## Community Standard Vocabularies
8
8
@@ -11,13 +11,13 @@ The following vocabularies are sourced from established oceanographic & scientif
|**Units**|[QUDT](https://qudt.org/vocab/unit/)| Dosing concentration units |
17
17
18
18
## OAE Data Protocol Vocabularies
19
19
20
-
These vocabularies are defined as part of the [OAE Data Protocol](https://www.carbontosea.org/oae-data-protocol/1-0-0/#controlled-vocabularies) and maintained in this schema.
20
+
These vocabularies are defined as part of the [OAE Data Protocol](https://www.carbontosea.org/oae-data-protocol#controlled-vocabularies) and maintained in this schema.
0 commit comments