pywrdrb.Data

pywrdrb.Data#

class pywrdrb.Data(pn=PathNavigator(/home/runner/work/Pywr-DRB/Pywr-DRB/src/pywrdrb/data), **kwargs)#

A data loader for hydrologic data from various sources.

This class provides methods to load observation data, pywrdrb output data, and functionality to export/import data to/from HDF5 files.

load_observations(**kwargs)#

Load observational data based on specified results_sets.

load_output(ouput_filenames, \*\*kwargs)#

Load data from pywrdrb output files based on specified results_sets.

load_hydrologic_model_flow(flowtypes, \*\*kwargs)#

Load data from the available hydrologic model flow files.

export(file)#

Export all data stored in this object to an HDF5 file.

load_from_export(file)#

Load data from an HDF5 file into the object.

pn#

A pathnavigator object for handling file paths.

Type:

object

all_results_sets#

Combined list of all valid result sets across all data types.

Type:

list

default_kwargs#

Default keyword arguments used by the loader.

Type:

dict

results_sets#

List of result sets to load.

Type:

list

output_filenames#

List of pywrdrb output filenames to load.

Type:

list

units#

Units for the results.

Type:

str

print_status#

Whether to print status updates.

Type:

bool

__init__(pn=PathNavigator(/home/runner/work/Pywr-DRB/Pywr-DRB/src/pywrdrb/data), **kwargs)#

Initialize the Data loader with default and provided keyword arguments.

Parameters:

  • pn (object, optional) – A pathnavigator object for handling file paths. Default is the global pn object.

  • results_sets (list, optional) – List of results sets to load.

  • output_filenames (list, optional) – List of pywrdrb output filenames, with path, to load. Only necessary for Data.load_output().

  • units (str, optional) – Units for the results. Default is ‘MG’ (Million Gallons).

  • print_status (bool, optional) – Whether to print status updates. Default is False.

Examples

>>> from pywrdrb import Data
>>>
>>> # For loading observations data
>>> data = Data(results_sets=['major_flow'], print_status=True)
>>> data.load_observations()
>>>
>>> # For output data, must provide output filenames
>>> f = "./output_data/drb_output_nhmv10.hdf5"
>>> data.load_output(output_filenames=[f])

Methods

__init__([pn])

Initialize the Data loader with default and provided keyword arguments.

export(file)

Export all data stored in this object to an HDF5 file.

load_from_export(file)

Load data from an HDF5 file into the object.

load_hydrologic_model_flow(flowtypes, **kwargs)

Load data from the internally available hydrologic model flow files.

load_observations(**kwargs)

Load observational data.

load_output(**kwargs)

Load data from pywrdrb output files.

set_data(data, name)

Store or update data in the object as an attribute.
Contents