From 9241c4623e136d450b121751cf491b181d98836b Mon Sep 17 00:00:00 2001 From: danielfromearth Date: Thu, 16 May 2024 15:11:01 -0400 Subject: [PATCH] add an initial sambah_readme.md to the docs --- docs/sambah_readme.md | 25 +++++++++++++++++++++++++ mkdocs.yml | 2 ++ 2 files changed, 27 insertions(+) create mode 100644 docs/sambah_readme.md diff --git a/docs/sambah_readme.md b/docs/sambah_readme.md new file mode 100644 index 0000000..2733b58 --- /dev/null +++ b/docs/sambah_readme.md @@ -0,0 +1,25 @@ +# SAMBAH + +The Subsetter And Multi-dimensional Batched Aggregation in Harmony (SAMBAH) chain +executes several services: + +1. **CMR Query**: Retrieves information from the Common Metadata Repository (CMR) ([source](https://github.com/nasa/harmony/tree/main/services/query-cmr)) +2. **PODAAC L2-Subsetter** (optional): Performs subsetting on level-2 data granules ([source](https://github.com/podaac/l2ss-py)) +3. **Batchee**: Groups together filenames so that further operations (such as concatenation) can be performed separately on each group of files ([source](https://github.com/nasa/batchee)) +4. **Stitchee**: Concatenates netCDF data along an existing dimension ([source](https://github.com/nasa/stitchee)) +5. **PODAAC CONCISE**: Concatenates netCDF data along a newly created dimension ([source](https://github.com/podaac/concise)) + +## Known Limitations + +- + +## Missions supported + +The SAMBAH service chain is currently configured to work only with data collections +from the Tropospheric Emissions: Monitoring of Pollution (TEMPO) mission. + +## References + +- Service (UMM-S) record ID in CMR: [S2940253910-LARC_CLOUD](https://cmr.earthdata.nasa.gov/search/services.umm_json?concept_id=S2940253910-LARC_CLOUD) +- Service versions in Harmony Production: +- Harmony API - Service Capabilities: diff --git a/mkdocs.yml b/mkdocs.yml index 8e65e07..4af2998 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -22,6 +22,8 @@ theme: nav: - OVERVIEW: - "Readme": "index.md" + - SAMBAH Service Chain: + - "Description and known limitations": "sambah_readme.md" - EXAMPLES: - "Usage of STITCHEE via Harmony": "tutorial_examples.ipynb"