API Reference

Model

Model(tree, inputs[, init_states, ...])

Define a rameau model.

Inputs

FilePaths([rainfall, pet, temperature, ...])	File paths.
inputs.InputCollection(rainfall, pet[, ...])	Collection of Input representing either meteorological, observations, or pumping data time series for a given set of watersheds.
inputs.Input(data[, dates, nodata])	Input wrapping data time series as a two-dimensional numpy array with the corresponding dates.
inputs.InputFormat([meteo_files, ...])	Input format.

Settings

SimulationSettings([name, starting_date, ...])	Simulation settings.
SpinupSettings([cycles, starting_date, ...])	Spinup settings.
OptimizationSettings([maxit, starting_date, ...])	Model optimisation settings.
ForecastSettings([emission_date, scope, ...])	Forecast settings.
OutputSettings([budget, budget_riverflow, ...])	Output settings.

Tree

Tree(watersheds[, connection])	Watershed connection tree.
Watershed([name, correction, ...])	Watershed.

Parameters

Parameter([value, opti, lower, upper, sameas])	Physical parameter.
Meteo(columns, weights)	Collection of meteorological parameters to calculate meteorological time series of a given watershed from given inputs.
CorrectionParameters([area, pet, rainfall])	Correction parameters.
RiverParameters([area, exchange_riverflow, ...])	Parameters for calculating and/or optimising river flow in \(m^3.s^{-1}\).
ProgressiveReservoir([capacity, pet_decrease, h])	Soil reservoir using the GR3 approach [Edijatno and Michel, 1989].
ThornthwaiteReservoir([capacity, h])	Soil reservoir using the Thornthwaite approach [Thornthwaite, 1948].
TransferReservoir([halflife, runsee, ...])	Transfer reservoir.
OverflowParameters([halflife, threshold, loss])	Overflow parameters.
groundwater.GroundwaterParameters([...])	Groundwater parameters.
groundwater.GroundwaterReservoir([...])	Groundwater reservoir.
groundwater.StorageParameters([coefficient, ...])	Storage parameters.
snow.SnowReservoir([melting, retention, ...])	Snow reservoir.
snow.SnowCorrectionParameters([pet, ...])	Correction parameters applied to snow melting physical processes.
snow.DegreeDayParameters([coefficient, ...])	Degree day model parameters.
pumping.Pumping([river, groundwater])	Pumping parameters.
pumping.PumpingReservoir([coefficient, ...])	Pumping reservoir.
Influence([groundwater])	Influence parameters.

Simulation

simulation.Simulation()	rameau simulations.
simulation.OptiSimulation()	rameau optimization simulation.
simulation.ForecastSimulation()	rameau forecast simulation.

States

states.StatesCollection(states)	States collection.
states.States([h_thornthwaite, ...])	Model states.