Incoming data: Snow surface properties
The supercomputer processes data with esp and sends it, with SCP, to an NSIDC disk, in accordance with this interface. From here, the webapp back-end picks it up to prepare it for visualization by the webapp.
Allowing the supercomputer to be responsible for producing data and metadata, the webapp can focus on visualization and changes, for example adding new regions, won’t depend on the webapp to be also updated.
We need to to balance all of these concerns:
- Webapp load time: startup load time, and load time when changing regions & variables
- Webapp maintainability
- Flexibility to change webapp behavior by pushing different data from the supercomputer.
- Predictability in how the webapp will respond to data changes
Revisions
Current version: 1.0.0beta1
1.0.0
Initial release
Principles
- The webapp should be able to selectively load Sub Region data by selected Super Region
- Rationale: minimizes webapp start-up time and overall download.
- Everything has an ID
- Rationale: enables building relationships between Regions, Variables, etc. without sending too much extraneous data.
- Relative paths are relative to API root
- Rationale: it’s less stateful to reconstruct a URL this way (as opposed to if the relative path was relative to the file containing it)
- Data from the supercomputer MAY be unminified.
- Rationale: it can be minified on ingest.
- JSON attributes are
camelCase.- Rationale: consistency is good, it doesn’t matter what we pick.
Specification
Important
All data and metadata has a provider.
- Version control: Data is version-controlled in this repository’s
static/directory. - Supercomputer: Data is pushed dynamically on a schedule from the supercomputer.
| Title | Description | Provider |
|---|---|---|
| Cadence | The schedule and manner in which data and metadata are passed from the provider to NSIDC. | |
| Data: gridded | Gridded data (Cloud Optimized GeoTIFFs) that are displayed on the map user interface component. | Supercomputer |
| Data: plots | Plot data (JSON) that are displayed on the map user interface component. | Supercomputer |
| Metadata: regions | Any region that can be selected for viewing on the map or plot. Includes Super Regions and Sub Regions and information about their relationships.. | Supercomputer |
| Metadata: variables | Variables which are available for display either as gridded data on the map user interface component or as a line chart on the plot UI component. | Version control |
No matching items
Citation
BibTeX citation:
@online{lenard2024,
author = {Lenard, Sebastien and Fisher, Matt},
title = {Incoming Data: {Snow} Surface Properties},
date = {2024-01-05},
url = {https://nsidc.github.io/snow-today-webapp-server/interfaces/incoming_snow_surface_properties},
langid = {en}
}
For attribution, please cite this work as:
Lenard, Sebastien, and Matt Fisher. 2024. “Incoming Data: Snow
Surface Properties.” January 5, 2024. https://nsidc.github.io/snow-today-webapp-server/interfaces/incoming_snow_surface_properties.