InputCollection

class rameau.core.inputs.InputCollection(rainfall, pet, snow=None, temperature=None, riverobs=None, riverpumping=None, groundwaterobs=None, groundwaterpumping=None, dates=None)

Collection of Input representing either meteorological, observations, or pumping data time series for a given set of watersheds.

Data are passed to the constructor by keyword arguments whose names refer to the data types to store (e.g. rainfall, riverflow observations, etc.). Keyword arguments accept Input, numpy.ndarray or pandas.DataFrame. In the case of numpy.ndarray or pandas.DataFrame, data is converted into Input in the constructor.

If a pandas.DataFrame with a pandas.DatetimeIndex as index is passed, this index is used to set the input dates.

Parameters:

• rainfall (numpy.ndarray, Input or pandas.DataFrame) – Rainfall time series (mm).

• pet (ndarray, Input or DataFrame) – PET time series (mm).

• temperature (numpy.ndarray, Input or pandas.DataFrame, optional) – Temperature time series (°C).

• snow (numpy.ndarray, Input or pandas.DataFrame, optional) – Snowfall time series (mm).

• riverobs (numpy.ndarray, Input or pandas.DataFrame, optional) – Observed river flow time series (m3/s).

• groundwaterobs (numpy.ndarray, Input or pandas.DataFrame, optional) – Observed groundwater level time series (m).

• riverpumping (numpy.ndarray, Input or pandas.DataFrame, optional) – River pumping time series (m3/s).

• groundwaterpumping (numpy.ndarray, Input or pandas.DataFrame, optional) – Groundwater pumping time series (m3/s).

• dates (pandas.DatetimeIndex, optional) – If provided, overrides the dates of all the inputs in the collection.

Returns:

InputCollection

Notes

The consistency between each input (i.e. shapes of dates and data) is checked when setting the collection of inputs to the Model either through the constructor or by attribute assignment.

Methods

from_files(rainfall, pet[, temperature, ...])

Create InputCollection from CSV files.

Attributes

file_paths	Input data file paths.
groundwaterobs	Observed groundwater level time series (m)
groundwaterpumping	Groundwater pumping time series (m3/s)
input_format	Input data file format.
pet	PET time series (mm).
rainfall	Rainfall time series (mm).
riverobs	Observed river flow time series (m3/s)
riverpumping	River pumping time series (m3/s)
snow	Snow time series (mm)
temperature	Temperature time series (°C)