rameau.core.simulation.ForecastSimulation.get_riverflow_component

ForecastSimulation.get_riverflow_component(variables=None, header_type='name')

Get the components of the river flow (m3/s)

Parameters:

  • header_type (str, optional) – Whether to use the watershed identifiers or names as dataframe header.

  • variables (str, optional) –

    The components of the river flow to retrieve. Default is None, meaning all the components.

    variable

    description

    'runoff'

    The runoff component.

    'runoff_overflow'

    The runoff overflow component.

    'exchange'

    The exchange component. It corresponds to the exchange_riverflow parameter value.

    'pumping'

    The pumping/injection component.

    'baseflow'

    The baseflow component.

    'gw_exchange'

    The groundwater exchange component. It is related to the groundwater.#.exchanges parameter value.

    'gw_overflow'

    The groundwater overflow component.

    'deficit'

    The deficit component. It corresponds the water quantity that couldn’t been taken from the river.

Returns:

pandas.DataFrame