diff --git a/specs/SPEC-001-snippets.md b/specs/SPEC-001-snippets.md new file mode 100644 index 0000000..b407ff8 --- /dev/null +++ b/specs/SPEC-001-snippets.md @@ -0,0 +1,50 @@ +# Initial draft snippet specs + +## Authentication + +### Requirements + +- include generic inline comments describing code +- print a successful authentication + +### Template +```python +if earthaccess.login(persist=True).authenticated: + print("Authentication Completed") +``` + +## Spatiotemporal Search + +### Requirements + +- simple spatial bounding box for any collection that isn't global +- simple temporal range within the collections' time range +- use most recent granule? + +### Template +```python +granules = earthaccess.search_data( + doi="", + temporal=("", ""), + bounding_box=[] +) +print(f"Spatiotemporal search retrieved {len(granules)} granule(s)") +``` + +## Data Access + +- variable subsetting - pick out a meaningful variable +- show a mean/median, comment explaining lacking of quality filtering + +## Dataset Structure Navigation +- + +## Validation (external to snippet) + +- snippet runs to completion +- snippet produces real numbers (stored in a variable named `data`) + - numeric check is performed on unmasked/unfiltered data (to avoid depending on any science thresholds or analytic manipulations) + +# Out of scope: + +- Visualization or plotting