# ESS-DIVE Documentation

## ESS-DIVE Docs

- [Overview](https://docs.ess-dive.lbl.gov/master.md): This website serves as an in-depth guide to discover, manage, and publish high-quality data on ESS-DIVE and is home to all help documentation.
- [Frequently Asked Questions](https://docs.ess-dive.lbl.gov/faq.md)
- [Get Started](https://docs.ess-dive.lbl.gov/contributing-data/get-started.md): Use this page to help decide how you will upload your dataset to ESS-DIVE by considering file upload limits and dataset organization.
- [Large Data Support](https://docs.ess-dive.lbl.gov/contributing-data/get-started/large-data-support.md): Learn about ESS-DIVE's large data support tools and how they're used to upload and publish large data.
- [Register to Submit Data](https://docs.ess-dive.lbl.gov/contributing-data/new-contributor-registration.md): This page provides instructions for requesting approval to publish data on ESS-DIVE as an ESS-DIVE data contributor.
- [Data Reporting Formats](https://docs.ess-dive.lbl.gov/contributing-data/data-reporting-formats.md): Make your data more discoverable and usable by following reporting formats applicable to your data types.
- [Submit Data with Online Form](https://docs.ess-dive.lbl.gov/contributing-data/submit-data-with-online-form.md): This comprehensive tutorial will guide you through the process of creating and submitting a private dataset to ESS-DIVE.
- [Submit Data with the Dataset API](https://docs.ess-dive.lbl.gov/contributing-data/submit-data-with-the-dataset-api.md)
- [Code Examples](https://docs.ess-dive.lbl.gov/contributing-data/submit-data-with-the-dataset-api/code-examples.md)
- [Link to External Data Sources](https://docs.ess-dive.lbl.gov/contributing-data/link-to-external-data-sources.md): Connect data files and metadata stored in other repositories to your ESS-DIVE dataset. Read more to learn how External Linking works and when to use it.
- [Check Dataset Metadata Quality](https://docs.ess-dive.lbl.gov/publish-data/check-dataset-metadata-quality.md): Assessment Reports provide automated dataset metadata quality checks based on FAIR (Findable, Accessible, Interoperable, Reusable) data principles.
- [Dataset and DOI Status Badges](https://docs.ess-dive.lbl.gov/publish-data/dataset-and-doi-status-badges.md): Data contributors can review dynamic dataset statuses on their dataset landing pages prior to and after publication. Login is required to view statuses.
- [Review Cycle and Criteria](https://docs.ess-dive.lbl.gov/publish-data/review-cycle-and-criteria.md): The ESS-DIVE Team reviews all datasets before publication to assess the quality of metadata and any reporting format files.
- [Metadata Requirements](https://docs.ess-dive.lbl.gov/publish-data/review-cycle-and-criteria/package-level-metadata.md): This page provides an overview of the minimum metadata required for publication on ESS-DIVE. These requirements are used by the ESS-DIVE team to review datasets before approval for publication.
- [Reporting Format Requirements](https://docs.ess-dive.lbl.gov/publish-data/review-cycle-and-criteria/reporting-format-requirements.md): This page provides an overview of the review process for datasets utilizing reporting formats.
- [Publish your Dataset](https://docs.ess-dive.lbl.gov/publish-data/publish-your-dataset.md): Learn how to initiate a metadata review, receive a DOI, and make your data accessible to the public.
- [Request Publication](https://docs.ess-dive.lbl.gov/publish-data/publish-your-dataset/request-publication.md): Request a publication review to make your dataset and DOI available to the public.
- [Reserve DOI Before Publication](https://docs.ess-dive.lbl.gov/publish-data/publish-your-dataset/reserve-doi-before-publication.md): Obtain a new DOI for your private dataset prior to publication. You can return at a later date to finalize your dataset and request a publication review to make your data and DOI publicly available.
- [Publish with Existing DOI](https://docs.ess-dive.lbl.gov/publish-data/publish-your-dataset/publish-with-existing-doi.md): Use a DOI that your data was previously published under and let ESS-DIVE know that you do not want a new DOI.
- [Troubleshooting](https://docs.ess-dive.lbl.gov/publish-data/publish-your-dataset/troubleshooting.md)
- [Update your Public Dataset](https://docs.ess-dive.lbl.gov/publish-data/update-your-public-dataset.md)
- [Register Dataset Citations](https://docs.ess-dive.lbl.gov/manage-data/register-dataset-citations.md): You can now manually register your dataset citations in ESS-DIVE and improve your dataset metrics. Read this page to learn how to register your dataset citations.
- [Create Data Portals](https://docs.ess-dive.lbl.gov/manage-data/why-use-data-portals.md): You can now easily view related datasets all in one place.
- [How to Create & Publish Portals](https://docs.ess-dive.lbl.gov/manage-data/why-use-data-portals/how-to-create-portals.md): A step-by-step guide on how to navigate ESS-DIVE and create a new portal.
- [Share Data Permissions](https://docs.ess-dive.lbl.gov/manage-data/share-data-permissions.md): Registered data contributors can share their datasets and data portals with other individuals or teams to collaborate directly on ESS-DIVE.
- [Share Datasets](https://docs.ess-dive.lbl.gov/manage-data/share-data-permissions/share-datasets.md)
- [Share Portals](https://docs.ess-dive.lbl.gov/manage-data/share-data-permissions/share-portals.md)
- [Manage Project Data](https://docs.ess-dive.lbl.gov/manage-data/manage-project-data.md): A suite of features used to manage your project's data and teams on ESS-DIVE
- [Project Data Managers](https://docs.ess-dive.lbl.gov/manage-data/manage-project-data/project-data-managers.md): First register yourself as a project data manager to gain access to project management features
- [Project Information](https://docs.ess-dive.lbl.gov/manage-data/manage-project-data/project-information.md): Project Data Managers can these pages to review and update project metadata as needed.
- [Project Teams](https://docs.ess-dive.lbl.gov/manage-data/manage-project-data/project-teams.md): Create project teams to leverage ESS-DIVE's evolving suite of project management features
- [Search for Data](https://docs.ess-dive.lbl.gov/searching-and-accessing-data/data-access.md)
- [Download Data](https://docs.ess-dive.lbl.gov/searching-and-accessing-data/accessing-data.md): Public data files on ESS-DIVE can be accessed by anyone through unique dataset landing pages, where they are accompanied by relevant metadata. There is no login requirement to download data.
- [Access Data Portals](https://docs.ess-dive.lbl.gov/searching-and-accessing-data/find-portals.md): Visit the portal page to view a list of all portals published on ESS-DIVE.
- [Search with Dataset API](https://docs.ess-dive.lbl.gov/searching-and-accessing-data/search-with-dataset-api.md): Public datasets can be programmatically searched and downloaded by anyone using the Dataset API. ORCID login is required to use the API.
- [Code Examples](https://docs.ess-dive.lbl.gov/searching-and-accessing-data/search-with-dataset-api/code-examples.md): This page provides quick coding examples for searching for datasets on ESS-DIVE using Python, R, and Java.
- [Search with Deep Dive API](https://docs.ess-dive.lbl.gov/searching-and-accessing-data/search-with-deep-dive-api.md): An advanced search tool within data files on ESS-DIVE that meet certain standard criteria.
- [How to Query Data](https://docs.ess-dive.lbl.gov/searching-and-accessing-data/search-with-deep-dive-api/how-to-query-data.md): A workflow for data discovery that walks through the intended use of the Deep Dive API search endpoints.
- [ESS-DIVE Dataset API](https://docs.ess-dive.lbl.gov/programmatic-tools/ess-dive-dataset-api.md): The ESS-DIVE Dataset API is a service that enables users to programmatically submit and manage datasets with ESS-DIVE. This guide provides an overview of the API, resources, and how to get started.
- [Setup and Troubleshoot](https://docs.ess-dive.lbl.gov/programmatic-tools/ess-dive-dataset-api/setup-and-troubleshoot.md)
- [API Updates and Changes](https://docs.ess-dive.lbl.gov/programmatic-tools/ess-dive-dataset-api/change-log.md): This page provides information about all versions of the Dataset API. It includes a log of new features, enhancements, and bug fixes that have been made to the API.
- [Globus Data Transfer Service](https://docs.ess-dive.lbl.gov/programmatic-tools/large-data-support.md): Globus is an offline service used by ESS-DIVE to upload large data files to the ESS-DIVE repository.
- [Setup Globus](https://docs.ess-dive.lbl.gov/programmatic-tools/large-data-support/how-to-setup-globus.md): Learn how to log in to Globus, install the Globus desktop application, and create a collection.
- [Upload Data with Globus](https://docs.ess-dive.lbl.gov/programmatic-tools/large-data-support/how-to-upload-large-data.md): Learn how to transfer your files to Globus from Globus Connect Personal or an existing Globus endpoint.
- [FAQs](https://docs.ess-dive.lbl.gov/programmatic-tools/large-data-support/faqs.md)