CamelsUS

class hy2dl.datasetzoo.camelsus.CAMELS_US(cfg: Config, time_period: str, gauge_id: str | list[str] | None = None)

Bases: BaseDataset

Class to process data from the CAMELS US dataset [1] [2].

The class inherits from BaseDataset to execute the operations on how to load and process the data. However here we code the _read_attributes and _read_data methods, that specify how we should read the information from CAMELS-US.

This class was adapted from NeuralHydrology [3].

Parameters:

  • cfg (Config) – Configuration file.

  • time_period ({'training', 'validation', 'testing'}) – Defines the period for which the data will be loaded.

  • gauge_id (Optional[str | list[str]], default=None) – Id of gauge(s) to be loaded.

References