stactools-noaa-cdr 0.2.1

NOAA Climate Data Records (CDR) stactools package

stactools-noaa-cdr

• Name: noaa-cdr
• Package: stactools.noaa_cdr
• stactools-noaa-cdr on PyPI
• Owner: @gadomski
• Dataset homepage
• STAC extensions used:
  • item assets
  • proj
  • raster
  • scientific
  • classification
• Extra fields:
  • noaa_cdr:interval: The time resolution (derived from the time_coverage_resolution field) of the dataset. Useful for filtering multi-temporal-resolution CDRs, such as ocean heat content.
  • noaa_cdr:max_depth: The maximum depth of the measurements. Only used for ocean-heat-content.
• Browse the example in human-readable form

STAC Examples

• Collections
  • Ocean heat content
  • Sea ice concentration
  • Sea surface temperature - optimum interpolation
  • Sea surface temperature - WHOI
• Items
  • Ocean heat content, yearly for 2021, 2000m depth
  • Sea ice concentration, daily, northern hemisphere
  • Sea surface temperature - optimum interpolation
  • Sea surface temperature - WHOI

Layout

Each Climate Data Record can have multiple subdatasets, which themselves can be organized by time intervals and other attributes. We have chosen to create one STAC collection for each CDR, and to organize items in that collection by time interval and time window. Subdatasets are included as COG assets.

Because each CDR has a different data layout in its NetCDFs, the mapping from NetCDF(s) to STAC Collections and Items varies from CDR to CDR. The diagram below is an abstract representation of those layouts. Note that the class names do not directly correspond to code entities; this is strictly a conceptual diagram. Note too the 8-1 relationship between SeaSurfaceTemperatureWHOIItem and SeaSurfaceTemperatureWHOINetCDF; each SST-WHOI NetCDF contains eight timesteps, and so breaks apart into eight STAC items per NetCDF.

classDiagram
  direction LR

  class OceanHeatContent
  <<Collection>> OceanHeatContent

  class SeaIceConcentration
  <<Collection>> SeaIceConcentration

  class SeaSurfaceTemperatureOptimumInterpolation
  <<Collection>> SeaSurfaceTemperatureOptimumInterpolation

  class SeaSurfaceTemperatureWHOI
  <<Collection>> SeaSurfaceTemperatureWHOI


  OceanHeatContent "1" --> "n" OceanHeatContentNetCDF
  OceanHeatContent "1" --> "0..n" OceanHeatContentItem

  SeaIceConcentration "1" --> "0..n" SeaIceConcentrationItem
  SeaIceConcentrationItem "1" --> "1" SeaIceConcentrationNetCDF

  SeaSurfaceTemperatureOptimumInterpolation "1" --> "0..n" SeaSurfaceTemperatureOptimumInterpolationItem
  SeaSurfaceTemperatureOptimumInterpolationItem "1" --> "1" SeaSurfaceTemperatureOptimumInterpolationNetCDF

  SeaSurfaceTemperatureWHOI "1" --> "0..n" SeaSurfaceTemperatureWHOIItem
  SeaSurfaceTemperatureWHOIItem "8" --> "1" SeaSurfaceTemperatureWHOINetCDF

Installation

pip install stactools-noaa-cdr

Command-line Usage

To create a collection, e.g. for the Ocean heat content CDR:

stac noaa-cdr ocean-heat-content create-collection examples/ocean-heat-content/collection.json

To create COGs and items:

stac noaa-cdr ocean-heat-content create-collection --create-items \
  examples/ocean-heat-content/collection.json

To only create COGs and items for the latest data (e.g. to create a small example collection):

stac noaa-cdr ocean-heat-content create-collection --create-items --latest-only \
  examples/ocean-heat-content/collection.json

Each CDR has its own flavor of command line interface; use stac noaa-cdr --help to see a list of supported CDRs.

Contributing

We use pre-commit to check any changes. To set up your development environment:

pip install -e .
pip install -r requirements-dev.txt
pre-commit install

To check all files:

pre-commit run --all-files

To run the tests:

pytest

Updating static resources

There are several .json files in the source tree that are used to populate metadata when creating collections and items. There are two helper scripts in the scripts/ directory that update these files.

scripts/create_item_assets.py
scripts/extract_netcdf_asset_metadata.py > src/stactools/noaa_cdr/ocean-heat-content/asset-metadata.json

Additionally, there is a script to create the examples/ directory:

scripts/create_examples.py