Skip to main content
Ctrl+K
rameau 0.0.8 documentation - Home rameau 0.0.8 documentation - Home
  • Getting started
  • User guide
  • API Reference
  • Bibliography
  • GitLab
  • Getting started
  • User guide
  • API Reference
  • Bibliography
  • GitLab

Section Navigation

  • Model
    • rameau.core.Model.create_simulation
    • rameau.core.Model.from_toml
    • rameau.core.Model.get_input
    • rameau.core.Model.run_forecast
    • rameau.core.Model.run_optimization
    • rameau.core.Model.run_simulation
    • rameau.core.Model.to_toml
    • rameau.core.Model.forecast_settings
    • rameau.core.Model.init_states
    • rameau.core.Model.inputs
    • rameau.core.Model.optimization_settings
    • rameau.core.Model.output_settings
    • rameau.core.Model.simulation_settings
    • rameau.core.Model.tree
  • FilePaths
    • rameau.core.FilePaths.groundwaterobs
    • rameau.core.FilePaths.groundwaterpumping
    • rameau.core.FilePaths.pet
    • rameau.core.FilePaths.rainfall
    • rameau.core.FilePaths.riverobs
    • rameau.core.FilePaths.riverpumping
    • rameau.core.FilePaths.snow
    • rameau.core.FilePaths.states
    • rameau.core.FilePaths.temperature
    • rameau.core.FilePaths.tree
  • InputCollection
    • rameau.core.inputs.InputCollection.from_files
    • rameau.core.inputs.InputCollection.file_paths
    • rameau.core.inputs.InputCollection.groundwaterobs
    • rameau.core.inputs.InputCollection.groundwaterpumping
    • rameau.core.inputs.InputCollection.input_format
    • rameau.core.inputs.InputCollection.pet
    • rameau.core.inputs.InputCollection.rainfall
    • rameau.core.inputs.InputCollection.riverobs
    • rameau.core.inputs.InputCollection.riverpumping
    • rameau.core.inputs.InputCollection.snow
    • rameau.core.inputs.InputCollection.temperature
  • Input
    • rameau.core.inputs.Input.data
    • rameau.core.inputs.Input.dates
    • rameau.core.inputs.Input.nodata
  • InputFormat
    • rameau.core.inputs.InputFormat.meteo_files
    • rameau.core.inputs.InputFormat.starting_date
    • rameau.core.inputs.InputFormat.time_step
  • SimulationSettings
    • rameau.core.SimulationSettings.name
    • rameau.core.SimulationSettings.spinup_settings
    • rameau.core.SimulationSettings.starting_date
  • SpinupSettings
    • rameau.core.SpinupSettings.cycles
    • rameau.core.SpinupSettings.ending_date
    • rameau.core.SpinupSettings.starting_date
  • OptimizationSettings
    • rameau.core.OptimizationSettings.ending_date
    • rameau.core.OptimizationSettings.maxit
    • rameau.core.OptimizationSettings.method
    • rameau.core.OptimizationSettings.river_objective_function
    • rameau.core.OptimizationSettings.selected_watersheds
    • rameau.core.OptimizationSettings.starting_date
    • rameau.core.OptimizationSettings.transformation
    • rameau.core.OptimizationSettings.verbose
  • ForecastSettings
    • rameau.core.ForecastSettings.correction
    • rameau.core.ForecastSettings.emission_date
    • rameau.core.ForecastSettings.norain
    • rameau.core.ForecastSettings.pumping_date
    • rameau.core.ForecastSettings.quantiles
    • rameau.core.ForecastSettings.quantiles_output
    • rameau.core.ForecastSettings.scope
    • rameau.core.ForecastSettings.year_members
  • OutputSettings
    • rameau.core.OutputSettings.budget
    • rameau.core.OutputSettings.metrics
    • rameau.core.OutputSettings.parameters
    • rameau.core.OutputSettings.states
    • rameau.core.OutputSettings.toml
  • Tree
    • rameau.core.Tree.from_csv
    • rameau.core.Tree.to_csv
    • rameau.core.Tree.connection
    • rameau.core.Tree.watersheds
  • Watershed
    • rameau.core.Watershed.correction
    • rameau.core.Watershed.forecast_correction
    • rameau.core.Watershed.groundwater
    • rameau.core.Watershed.id
    • rameau.core.Watershed.is_confluence
    • rameau.core.Watershed.meteo
    • rameau.core.Watershed.name
    • rameau.core.Watershed.progressive_reservoir
    • rameau.core.Watershed.pumping
    • rameau.core.Watershed.river
    • rameau.core.Watershed.snow_reservoir
    • rameau.core.Watershed.strahler_order
    • rameau.core.Watershed.thornthwaite_reservoir
    • rameau.core.Watershed.transfer_reservoir
  • Parameter
    • rameau.core.Parameter.lower
    • rameau.core.Parameter.opti
    • rameau.core.Parameter.sameas
    • rameau.core.Parameter.upper
    • rameau.core.Parameter.value
  • Meteo
    • rameau.core.Meteo.columns
    • rameau.core.Meteo.weights
  • CorrectionParameters
    • rameau.core.CorrectionParameters.area
    • rameau.core.CorrectionParameters.pet
    • rameau.core.CorrectionParameters.rainfall
  • RiverParameters
    • rameau.core.RiverParameters.area
    • rameau.core.RiverParameters.area_corr
    • rameau.core.RiverParameters.area_cum
    • rameau.core.RiverParameters.concentration_time
    • rameau.core.RiverParameters.minimum_riverflow
    • rameau.core.RiverParameters.obslim
    • rameau.core.RiverParameters.propagation_time
    • rameau.core.RiverParameters.weight
  • ProgressiveReservoir
    • rameau.core.ProgressiveReservoir.production
    • rameau.core.ProgressiveReservoir.capacity
    • rameau.core.ProgressiveReservoir.h
    • rameau.core.ProgressiveReservoir.pet_decrease
  • ThornthwaiteReservoir
    • rameau.core.ThornthwaiteReservoir.production
    • rameau.core.ThornthwaiteReservoir.capacity
    • rameau.core.ThornthwaiteReservoir.h
  • TransferReservoir
    • rameau.core.TransferReservoir.transfer
    • rameau.core.TransferReservoir.h
    • rameau.core.TransferReservoir.halflife
    • rameau.core.TransferReservoir.overflow
    • rameau.core.TransferReservoir.runsee
  • OverflowParameters
    • rameau.core.OverflowParameters.halflife
    • rameau.core.OverflowParameters.loss
    • rameau.core.OverflowParameters.threshold
  • GroundwaterParameters
    • rameau.core.groundwater.GroundwaterParameters.base_level
    • rameau.core.groundwater.GroundwaterParameters.observed_reservoir
    • rameau.core.groundwater.GroundwaterParameters.obslim
    • rameau.core.groundwater.GroundwaterParameters.reservoirs
    • rameau.core.groundwater.GroundwaterParameters.storage
    • rameau.core.groundwater.GroundwaterParameters.weight
  • GroundwaterReservoir
    • rameau.core.groundwater.GroundwaterReservoir.transfer
    • rameau.core.groundwater.GroundwaterReservoir.exchanges
    • rameau.core.groundwater.GroundwaterReservoir.h
    • rameau.core.groundwater.GroundwaterReservoir.halflife_baseflow
    • rameau.core.groundwater.GroundwaterReservoir.halflife_drainage
    • rameau.core.groundwater.GroundwaterReservoir.overflow
  • StorageParameters
    • rameau.core.groundwater.StorageParameters.coefficient
    • rameau.core.groundwater.StorageParameters.regression
  • SnowReservoir
    • rameau.core.snow.SnowReservoir.production
    • rameau.core.snow.SnowReservoir.degree_day
    • rameau.core.snow.SnowReservoir.melting
    • rameau.core.snow.SnowReservoir.r
    • rameau.core.snow.SnowReservoir.retention
    • rameau.core.snow.SnowReservoir.snow_correction
    • rameau.core.snow.SnowReservoir.swe
  • SnowCorrectionParameters
    • rameau.core.snow.SnowCorrectionParameters.pet
    • rameau.core.snow.SnowCorrectionParameters.rainfall
    • rameau.core.snow.SnowCorrectionParameters.temperature
  • DegreeDayParameters
    • rameau.core.snow.DegreeDayParameters.coefficient
    • rameau.core.snow.DegreeDayParameters.temperature
  • Pumping
    • rameau.core.pumping.Pumping.groundwater
    • rameau.core.pumping.Pumping.river
  • PumpingReservoir
    • rameau.core.pumping.PumpingReservoir.coefficient
    • rameau.core.pumping.PumpingReservoir.halflife_fall
    • rameau.core.pumping.PumpingReservoir.halflife_rise
  • Simulation
    • rameau.core.simulation.Simulation.get_budget
    • rameau.core.simulation.Simulation.get_input
    • rameau.core.simulation.Simulation.get_metrics
    • rameau.core.simulation.Simulation.get_output
    • rameau.core.simulation.Simulation.get_states
    • rameau.core.simulation.Simulation.run
    • rameau.core.simulation.Simulation.set_states
    • rameau.core.simulation.Simulation.to_toml
    • rameau.core.simulation.Simulation.write_outputs
    • rameau.core.simulation.Simulation.final_states
    • rameau.core.simulation.Simulation.output_settings
    • rameau.core.simulation.Simulation.simulation_settings
    • rameau.core.simulation.Simulation.tree
  • OptiSimulation
    • rameau.core.simulation.OptiSimulation.get_budget
    • rameau.core.simulation.OptiSimulation.get_input
    • rameau.core.simulation.OptiSimulation.get_metrics
    • rameau.core.simulation.OptiSimulation.get_opti_metrics
    • rameau.core.simulation.OptiSimulation.get_output
    • rameau.core.simulation.OptiSimulation.get_states
    • rameau.core.simulation.OptiSimulation.run
    • rameau.core.simulation.OptiSimulation.set_states
    • rameau.core.simulation.OptiSimulation.to_toml
    • rameau.core.simulation.OptiSimulation.write_outputs
    • rameau.core.simulation.OptiSimulation.final_states
    • rameau.core.simulation.OptiSimulation.optimization_settings
    • rameau.core.simulation.OptiSimulation.simulation_settings
    • rameau.core.simulation.OptiSimulation.output_settings
    • rameau.core.simulation.OptiSimulation.tree
  • ForecastSimulation
    • rameau.core.simulation.ForecastSimulation.get_budget
    • rameau.core.simulation.ForecastSimulation.get_forecast_output
    • rameau.core.simulation.ForecastSimulation.get_input
    • rameau.core.simulation.ForecastSimulation.get_metrics
    • rameau.core.simulation.ForecastSimulation.get_opti_metrics
    • rameau.core.simulation.ForecastSimulation.get_output
    • rameau.core.simulation.ForecastSimulation.get_states
    • rameau.core.simulation.ForecastSimulation.run
    • rameau.core.simulation.ForecastSimulation.set_states
    • rameau.core.simulation.ForecastSimulation.to_toml
    • rameau.core.simulation.ForecastSimulation.write_outputs
    • rameau.core.simulation.ForecastSimulation.final_states
    • rameau.core.simulation.ForecastSimulation.forecast_settings
    • rameau.core.simulation.ForecastSimulation.optimization_settings
    • rameau.core.simulation.ForecastSimulation.simulation_settings
    • rameau.core.simulation.ForecastSimulation.output_settings
    • rameau.core.simulation.ForecastSimulation.tree
  • StatesCollection
    • rameau.core.states.StatesCollection.from_file
    • rameau.core.states.StatesCollection.to_file
    • rameau.core.states.StatesCollection.states
  • States
    • rameau.core.states.States.gm_pump_gw
    • rameau.core.states.States.gm_pump_riv
    • rameau.core.states.States.h_groundwater
    • rameau.core.states.States.h_progressive
    • rameau.core.states.States.h_pump_gw
    • rameau.core.states.States.h_pump_riv
    • rameau.core.states.States.h_snow
    • rameau.core.states.States.h_thornthwaite
    • rameau.core.states.States.h_transfer
    • rameau.core.states.States.q_local
    • rameau.core.states.States.q_outlet
    • rameau.core.states.States.r_snow
  • API Reference
  • StatesCollection

StatesCollection

class rameau.core.states.StatesCollection(states)[source]

States collection.

Parameters:

states (list) – List of watershed States to store in the StatesCollection.

Returns:

StatesCollection

Methods

from_file(path)

Load StatesCollection from the text file.

to_file(path[, index])

Dump StatesCollection to text file.

Attributes

states

Derived Type Vector descriptor.

On this page
  • StatesCollection
Show Source

© Copyright 2025, BRGM.

Created using Sphinx 8.1.3.

Last updated on May 15, 2025.

Marianne+BRGM logo Marianne+BRGM logo