> For the complete documentation index, see [llms.txt](https://ess-dive.gitbook.io/dataset-metadata/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://ess-dive.gitbook.io/dataset-metadata/readme.md).

# ESS-DIVE dataset metadata v1.0.0

## About the reporting format

The ESS-DIVE dataset metadata reporting format ensures that all datasets submitted to the [ESS-DIVE data repository](https://ess-dive.lbl.gov/) have consistent and complete metadata. Complete metadata can enable data discovery and data resue. When creating the reporting format, the ESS-DIVE team reviewied existing metadata schema including [JSON-LD](https://json-ld.org/) and [Ecological Metadata Language](https://eml.ecoinformatics.org/). By ensuring that the resulting ESS-DIVE metadata reporitng format aligned as much as possible with existing schema and other resources, this enables our reporitng format to interoperate with other data modeling languages and data repositories.

When ESS-DIVE's data contributors [submit data to the repository](https://data.ess-dive.lbl.gov/submit), they are asked to fill out metadata for their entire dataset. Users can enter this metadata through our point-and-click [web form](https://docs.ess-dive.lbl.gov/contributing-data/data-submission-guidelines/complete-guide) or [programatically via our API](https://docs.ess-dive.lbl.gov/contributing-data/data-submission-guidelines/package-service-tutorial). Because the previously mentioned links include step-by-step guidance on how to submit data, in this GitHub repository, we share documents that explain our metadata schema and development process.

## Quickstart guide

* [Dataset metadata terminology and definitions](https://github.com/ess-dive-workspace/essdive-dataset-metadata/blob/main/specifications/dataset_metadata_guide.md)
* [Crosswalk with existing metadata schema](https://github.com/ess-dive-workspace/essdive-dataset-metadata/blob/main/specifications/dataset_metadata_crosswalk.md)

Templates:

* [Downloadable template for dataset metadata reporting format](https://github.com/ess-dive-workspace/essdive-dataset-metadata/blob/main/dataset_metadata_template.docx)

## Updates in v1.0.1

In March 2025, a patch version of the ESS-DIVE Dataset Metadata reporting format was made to improve the overall experience with the associated reporting format documentation.

## How to contribute

We encourage suggestions for improving the ESS-DIVE dataset metadata template and documentations. Please submit a GitHub issue using one of our [issue templates](https://github.com/ess-dive-workspace/essdive-dataset-metadata/issues/new/choose) to suggest changes.

Also, you can always email the ESS-DIVE support team at ess-dive-support (at) lbl.gov

## Licensing information

This repository content is license for use under the [CC BY 4.0 license](https://creativecommons.org/licenses/by/4.0/)

## Funding and acknowledgements

Funding for the development of ESS-DIVE's dataset metadata reporting format was provided by the U.S. Department of Energy, Office of Science, Office of Biological and Environmental Research, Climate and Environmental Science Division, Data Management program under contract number DE-AC02-05CH11231.

## Recommended Citation

Agarwal, D., Cholia, S., Hendrix, V. C., Crystal-Ornelas, R., Snavely, C., Damerow, J., & Varadharajan. (2022). ESS-DIVE Reporting Format for Dataset Metadata. Environmental Systems Science Data Infrastructure for a Virtual Ecosystem (ESS-DIVE), ESS-DIVE repository. <https://doi.org/10.15485/1866026>

## Additional resources

Documentation available ESS-DIVE's dataset metadata <https://docs.ess-dive.lbl.gov/contributing-data/package-level-metadata>