Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add an initial sambah_readme.md to the docs #195

Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 25 additions & 0 deletions docs/sambah_readme.md
Original file line number Diff line number Diff line change
@@ -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: <https://harmony.earthdata.nasa.gov/versions>
- Harmony API - Service Capabilities: <https://harmony.earthdata.nasa.gov/docs#service-capabilities>
2 changes: 2 additions & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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"

Expand Down
Loading