hydrotools.nwm_client.NWMFileCatalog module

NWM File Catalog

Tools for discovering operational NWM NetCDF data from file-based sources.

Classes

NWMFileCatalog

class hydrotools.nwm_client.NWMFileCatalog.NWMFileCatalog

Bases: ABC

Abstract base class for sources of NWM file data.

_abc_impl = <_abc._abc_data object>

property configurations: List[str]

abstract list_blobs(configuration: str, reference_time: str) → List[str]

Abstract method to query for NWM files.

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 %Y%m%dT%HZ format.

Return type:

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

raise_invalid_configuration(configuration) → None

Raises an error for an invalid configuration.

Parameters:

configuration (str, required) – Configuration to validate

Return type:

None

Raises:

ValueError if the configuration is invalid. –

static separate_datetime(reference_time: Timestamp) → Tuple[str, str]

Divide reference time into separate date and time strings.

Parameters:

reference_time (pandas.Timestamp, required) – pandas.Timestamp compatible datetime object

Returns:

Two strings

Return type:

issue_date, issue_time