hydrotools.nwm_client.AzureFileCatalog module¶

NWM Azure Blob Storage Container File Catalog¶

Concrete implementation of a National Water Model file client for discovering files on Microsoft Azure.

AzureFileCatalog

class hydrotools.nwm_client.AzureFileCatalog.AzureFileCatalog(server: str = 'https://noaanwm.blob.core.windows.net/')¶

An Azure Cloud client class for NWM data. This AzureFileCatalog class provides various methods for discovering NWM files on Azure Blob Storage.

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.