hydrotools.nwm_client.GCPFileCatalog module

NWM Google Cloud Platform File Catalog

Concrete implementation of a National Water Model file client for discovering files on Google Cloud Platform (GCP).

GCP – https://console.cloud.google.com/marketplace/details/noaa-public/national-water-model

Classes

GCPFileCatalog

class hydrotools.nwm_client.GCPFileCatalog.GCPFileCatalog(bucket_name: str = 'national-water-model')

Bases: NWMFileCatalog

A Google Cloud client class for NWM data. This GCPFileCatalog class provides various methods for discovering NWM files on Google Cloud Platform.

_abc_impl = <_abc._abc_data object>
property bucket_name: str
list_blobs(configuration: str, reference_time: str, must_contain: str = 'channel_rt') → List[str]

List available blobs with provided parameters.

Parameters:

  • configuration (str, required) – Particular model simulation or forecast configuration. For a list of available configurations see NWMDataService.configurations

  • reference_time (str, required) – Model simulation or forecast issuance/reference time in YYYYmmddTHHZ format.

  • must_contain (str, optional, default 'channel_rt') – Optional substring found in each blob name.

Return type:

A list of blob names that satisfy the criteria set by the parameters.