> For the complete documentation index, see [llms.txt](https://docs.ess-dive.lbl.gov/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.ess-dive.lbl.gov/contributing-data/data-reporting-formats.md).

# Data Reporting Formats

Reporting formats are data standards developed by ESS-DIVE and [partner projects](https://ess-dive.lbl.gov/partner-projects/) to standardize metadata and data files of data types commonly collected by DOE ESS projects. These reporting formats will be used to enable synthesis across datasets on ESS-DIVE. The DOE's Office of Science Biological and Environmental Research program supported the development of the data reporting formats.

**To get started**, click on a documentation link from one of the tables below according to the reporting format of interest. 

{% hint style="success" %}
If you are submitting a dataset on ESS-DIVE that follows any reporting formats, include the corresponding "Dataset Keyword" within the Keywords dataset metadata field.
{% endhint %}

Each reporting format has documentation hosted on both **GitBook** and **GitHub**. Content is exactly the same on both platforms; however, the **GitBook** interface is generally more user-friendly. Additionally, you can easily access the respective **templates** from the tables below.

{% hint style="info" %}
ESS-DIVE develops reporting formats on GitHub based on community input. Submit your comments and suggestions through ***GitHub issues**.* To view the latest status of the reporting formats, check the reporting formats page here:

<p align="center"><a href="https://ess-dive.lbl.gov/data-reporting-formats/#:~:text=data%20reporting%20format.-,Reporting%20Format,Status,-Dataset%20Metadata" class="button primary" data-icon="check-double">Check the status of the reporting formats</a></p>
{% endhint %}

## File Level Metadata

| Purpose         | Provide metadata for each data file uploaded to ESS-DIVE regardless of file type through the File Level Metadata (FLMD). Provide an explanation of headers for CSV through the Data Dictionary (DD).                                                                                                                                                                                          |
| --------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Documentation   | [GitHub](https://github.com/ess-dive-community/essdive-file-level-metadata) or [GitBook](https://ess-dive.gitbook.io/file-level-metadata-reporting-format/); [FLMD](https://github.com/ess-dive-community/essdive-file-level-metadata/blob/main/flmd_template.csv) and [DD](https://github.com/ess-dive-community/essdive-file-level-metadata/blob/main/CSV_dd/CSV_dd_template.csv) Templates |
| FLMD standard   | ESS-DIVE FLMD v1                                                                                                                                                                                                                                                                                                                                                                              |
| Dataset Keyword | ESS-DIVE File Level Metadata Reporting Format                                                                                                                                                                                                                                                                                                                                                 |
| Authors         | Terri Velliquette; Ranjeet Devarakonda; Jessica N. Welch; Michael Crow; Susan Heinz                                                                                                                                                                                                                                                                                                           |
| Institution     | Oak Ridge National Laboratory                                                                                                                                                                                                                                                                                                                                                                 |

## CSV File Structure

| Purpose         | Guidance for formatting CSV files submitted to ESS-DIVE                                                                                                                                                                                                         |
| --------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Documentation   | [GitHub](https://github.com/ess-dive-community/essdive-csv-structure) or [GitBook](https://ess-dive.gitbook.io/csv-file-structure-reporting-format/); [Guidelines](https://github.com/ess-dive-workspace/essdive-csv-structure/blob/main/csv_detailed_guide.md) |
| FLMD standard   | ESS-DIVE CSV v1                                                                                                                                                                                                                                                 |
| Dataset Keyword | ESS-DIVE CSV File Formatting Guidelines Reporting Format                                                                                                                                                                                                        |
| Authors         | Terri Velliquette; Ranjeet Devarakonda; Jessica N. Welch; Michael Crow; Susan Heinz                                                                                                                                                                             |
| Institution     | Oak Ridge National Laboratory                                                                                                                                                                                                                                   |

## Sample ID Metadata

<table data-header-hidden data-search="false"><thead><tr><th>Sample ID Metadata</th><th>Status: READY TO USE</th></tr></thead><tbody><tr><td>Purpose</td><td>Guidelines for assigning biological and environmental sample identifiers, describing sample collection details, and linking samples to related data in ESS-DIVE and elsewhere</td></tr><tr><td>Documentation</td><td><a href="https://github.com/ess-dive-community/essdive-sample-id-metadata">GitHub</a> or <a href="https://ess-dive.gitbook.io/sample-id-and-metadata/">GitBook</a>; <a href="https://github.com/ess-dive-community/essdive-sample-id-metadata/blob/master/sampleTemplate.xls">Template</a></td></tr><tr><td>FLMD standard</td><td>ESS-DIVE Sample v1</td></tr><tr><td>Dataset Keyword</td><td>ESS-DIVE Sample ID and Metadata Reporting Format</td></tr><tr><td>Authors</td><td>Joan Damerow</td></tr><tr><td>Institution</td><td>Lawrence Berkeley National Laboratory</td></tr></tbody></table>

## Soil Respiration

| Purpose         | Guidance for structuring data and metadata for soil respiration observations                                                                                                                                                                           |
| --------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| Documentation   | [GitHub](https://github.com/ess-dive-community/essdive-soil-respiration) or [GitBook](https://ess-dive.gitbook.io/soil-respiration-reporting-format/); [Templates](https://github.com/ess-dive-community/essdive-soil-respiration/tree/main/templates) |
| FLMD standard   | ESS-DIVE Soil Respiration v1                                                                                                                                                                                                                           |
| Dataset Keyword | ESS-DIVE Soil Respiration Reporting Format                                                                                                                                                                                                             |
| Authors         | Ben Bond-Lamberty and Stephanie Pennington                                                                                                                                                                                                             |
| Institution     | Pacific Northwest National Laboratory                                                                                                                                                                                                                  |

## Leaf-level Gas Exchange

| Purpose         | Guidance for leaf-level gas exchange data and metadata                                                                                                                                                                                           |
| --------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| Documentation   | [GitHub](https://github.com/ess-dive-community/essdive-leaf-gas-exchange) or [GitBook](https://ess-dive.gitbook.io/leaf-level-gas-exchange/); [Templates](https://github.com/ess-dive-community/essdive-leaf-gas-exchange/tree/master/templates) |
| FLMD standard   | ESS-DIVE Leaf-Level Gas Exchange v1                                                                                                                                                                                                              |
| Dataset Keyword | ESS-DIVE Leaf-Level Gas Exchange Reporting Format                                                                                                                                                                                                |
| Authors         | Kim Ely and Alistair Rogers                                                                                                                                                                                                                      |
| Institution     | Brookhaven National Laboratory                                                                                                                                                                                                                   |

## Hydrologic Monitoring

<table data-header-hidden data-search="false"><thead><tr><th>Hydrologic Monitoring</th><th>Status: READY TO USE</th></tr></thead><tbody><tr><td>Purpose</td><td>Guidance for reporting metrics such as water level, temperature, conductivity and more.</td></tr><tr><td>Documentation</td><td><a href="https://github.com/ess-dive-community/essdive-hydrologic-monitoring">GitHub</a> or <a href="https://ess-dive.gitbook.io/hydrologic-monitoring-data-and-metadata/">GitBook</a>; <a href="https://github.com/ess-dive-community/essdive-hydrologic-monitoring/tree/main/templates">Templates</a></td></tr><tr><td>FLMD standard</td><td>ESS-DIVE Hydrologic Monitoring v1</td></tr><tr><td>Dataset Keyword</td><td>ESS-DIVE Hydrologic Monitoring Reporting Format</td></tr><tr><td>Authors</td><td>Amy Goldman</td></tr><tr><td>Institution</td><td>Pacific Northwest National Laboratory</td></tr></tbody></table>

## Water and Soil Chemistry

| Purpose         | Guidance to format chemical concentration data for water, soil and sediment                                                                                                                                                                                               |
| --------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Documentation   | [GitHub](https://github.com/ess-dive-community/essdive-water-soil-sed-chem) or [GitBook](https://ess-dive.gitbook.io/water-soil-sediment-chemistry-reporting-format/); [Templates](https://github.com/ess-dive-community/essdive-water-soil-sed-chem/tree/main/templates) |
| FLMD standard   | ESS-DIVE Water-Soil-Sediment Chem v1                                                                                                                                                                                                                                      |
| Dataset Keyword | ESS-DIVE Water-Soil-Sediment Chemistry Reporting Format                                                                                                                                                                                                                   |
| Authors         | Kristin Boye                                                                                                                                                                                                                                                              |
| Institution     | SLAC National Accelerator Lab                                                                                                                                                                                                                                             |

## 16S Amplicon Sequencing

| Purpose         | Guidance for scientists producing 16S abundance data products                                                                                                                                                                                      |
| --------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Documentation   | [GitHub](https://github.com/ess-dive-community/essdive-amplicon) or [GitBook](https://ess-dive.gitbook.io/amplicon-sequencing-reporting-format/); [Templates](https://github.com/ess-dive-community/essdive-amplicon/tree/main/templates_and_maps) |
| FLMD standard   | ESS-DIVE Amplicon v1                                                                                                                                                                                                                               |
| Dataset Keyword | ESS-DIVE Amplicon Sequencing Reporting Format                                                                                                                                                                                                      |
| Authors         | Pamela Weisenhorn                                                                                                                                                                                                                                  |
| Institution     | Argonne National Lab                                                                                                                                                                                                                               |

## Model Data Archiving

| Purpose         | Guidance to structure model data submissions                                                                                                                       |
| --------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| Documentation   | [GitHub](https://github.com/ess-dive-community/essdive-model-data-archiving-guidelines) or [GitBook](https://ess-dive.gitbook.io/model-data-archiving-guidelines/) |
| FLMD standard   | ESS-DIVE Model Data v1                                                                                                                                             |
| Dataset Keyword | ESS-DIVE Model Data Archiving Guidelines                                                                                                                           |
| Authors         | Maegen Simmons                                                                                                                                                     |
| Institution     | Lawrence Berkeley National Lab                                                                                                                                     |

## Location metadata

<table data-header-hidden data-search="false"><thead><tr><th></th><th width="290"></th></tr></thead><tbody><tr><td>Purpose</td><td>Guidance for providing a minimal set of metadata about locations</td></tr><tr><td>Documentation</td><td><a href="https://github.com/ess-dive-workspace/essdive-location-metadata">GitHub</a> or <a href="https://ess-dive.gitbook.io/location-metadata/">GitBook</a>; <a href="https://github.com/ess-dive-workspace/essdive-location-metadata/tree/main/templates">Templates</a></td></tr><tr><td>FLMD Standard Term</td><td>ESS-DIVE Location v1</td></tr><tr><td>Dataset Keyword</td><td>ESS-DIVE Location Metadata Reporting Format</td></tr><tr><td>Authors</td><td>Rob Crystal-Ornelas</td></tr><tr><td>Institution</td><td>Lawrence Berkeley National Lab</td></tr></tbody></table>

## Unoccupied Aerial System data

<table data-header-hidden><thead><tr><th width="344.70660400390625"></th><th></th></tr></thead><tbody><tr><td>Purpose</td><td>Metadata content and data organization recommendations for UAS</td></tr><tr><td>Documentation</td><td><a href="https://github.com/ess-dive-community/essdive-uas">GitHub</a> or <a href="https://ess-dive.gitbook.io/uas-reporting-format">GitBook</a>; <a href="https://github.com/ess-dive-workspace/essdive-uas/tree/main/templates">Templates</a></td></tr><tr><td>FLMD standard</td><td>ESS-DIVE UAS v1</td></tr><tr><td>Dataset Keyword</td><td>ESS-DIVE Unoccupied Aerial Systems (UAS) Reporting Format</td></tr><tr><td>Authors</td><td>Kim Ely and Shawn Serbin</td></tr><tr><td>Institution</td><td>Brookhaven National Lab</td></tr></tbody></table>