rameau.core.simulation.ForecastSimulation.get_input

ForecastSimulation.get_input(variable='rainfall', header_type='name')

Get simulation input data.

Parameters:

  • variable (str, optional) –

    The simulation input variable to retrieve.

    variable

    description

    'rainfall'

    The simulation input rainfall data.

    'pet'

    The simulation input PET data.

    'snow'

    The simulation input snow data.

    'temperature'

    The simulation input temperature data.

    'riverobs'

    The river flow observation data.

    'groundwaterobs'

    The groundwater level observation data.

    'riverpumping'

    The river pumping data.

    'groundwaterpumping'

    The groundwater pumping data.

  • header_type (str, optional) –

    The header type of the returned pandas.DataFrame.

    header_type

    description

    'id'

    The header corresponds to the watershed identifiers as they were provided to build the Tree.

    'name'

    The header corresponds to the watershed names.

Returns:

pandas.DataFrame