Release notes

[0.3.0] 2026-05-04

Added

  • Add a get_riverflow_component method in simulation.

  • Add a load_inputs keyword in the Model.from_toml static method for avoiding to load inputs in memory if necessary.

  • Add missing parameter values in output csv text file.

  • Add a ending_date keywords to simulation settings.

Changed

  • Add possibility to request a specific period on which to compute metrics in get_metrics. get_opti_metrics is now depecrated.

  • Forecast pumping date can be set to older date than simulation starting date.

  • Now dataframe of simulation methods get_output/get_budget/get_input starts from simulation starting_date.

  • Regression used the fotran stdlib v0.8.1.

  • Fotran stdlib now compiled as a fallback subproject in meson build.

  • Composite design pattern for managing classes related to states.

Fixed

  • Fix inconsistency related to groundwater.observed_reservoir defined in [watershed.all] and groundwater reservoir numbers defined in specific watersheds when loading a modelfrom toml.

  • Fix missing pointer allocation for array_string in wrapper.

  • Fix memory leaks due to missing deallocate statement in wrappers.

  • Column number consistency with watershed number is now check in non-meteorological data.

  • Fix mistakes in the documentation.

[0.2.1] 2025-11-03

Added

  • Add warning for depecrated minimum_riverflow keyword argument

Fixed

  • Fix leak memories in fortran/c++/python wrappers.

[0.2.0] 2025-10-17

Added

  • Add multiple groundwater influences

  • Support conversion of eros weight/mesh file description to rameau

  • Add warning for deprecated toml keyword

Changed

  • Change key minimum_riverflow to exchange_riverflow

  • Improve description of GR3 model in documentation

Fixed

  • Fix segmentation fault when bad spinup starting/ending date in toml file

  • Fix minor bug in eros reader when converting meteo_files keyword

  • Fix wrong implementation of exchange riverflow from the legacy Gardenia (confusion between minimum and exchange riverflow)

[0.1.0] 2025-07-03

Added

  • Add a new keyword “direct_reservoir_pumping” for applying groundwater pumping directly in the groundwater reservoir. Should be used with a correct drainage area value.

  • Improve documentation and add test cases

  • Add a new keyword “unit_time_step” to provide halflife time value in time step rather than in month

  • Add a budget method to pumping reservoir

Changed

  • Refactor fortran to python wrappers

  • Default value for time step in input_fomat is 0 seconds. If > 0 , it will overwrite the time step value deduced from the rainfall time series.

  • Now if halflife = 0 in transfer reservoir, the whole flow is seepage and runoff = 0

Fixed

  • Apply halflife correction to last time step of forecast

  • Fix errors in digits when writing low values in toml

  • Fix errors in writing watershed names in toml

  • Fix rameau cli in python package and change the name of the executable to rameau-cli

  • Now groundwater.observed_reservoir is written in the output toml.

  • Now set all the model states to model initial states every time a simulation is created

[0.0.8] 2025-05-15

Fixed

  • Really estimates output correction halflife values in semi-distributed mode.

  • Fix minor bug in toml related to halflife_estimation key.

  • Fix 1e+20 values in snow column in budget if no snow data. Now to 0.

[0.0.7] 2025-05-15

Added

  • Add a to_toml method to Simulation objects

  • Add a write_output method to Simulation objects

  • Add output settings to Model and Simulation objects

  • Add forecast output correction halflife value estimation from Gardenia

Changed

  • Move error_type class to toml_error class in fortran

  • Move toml-f version from 0.3.1 to 0.4.2

  • No more tests included in package

  • CICD now in gitlab-brgm - in progress

  • Better cli script provided in the wheels

Fixed

  • Fix errors when reading hours and minutes in input files

[0.0.6] 2025-03-17

Added

  • First complete release in pypi

[0.0.5] 2025-03-15

Added

  • Now throw an error if a toml key doesn’t exist in the model

  • Add a CONTRIBUTING file

  • New update_paramkeyword in run simulation method

  • New riverpumpingdeficit output field

Changed

  • Modify README

  • Adapt the code to be compatible with the GPL license

  • Drastically improve documentation

  • Pass nanobind to 2.4.0 available on meson WrapDB

  • Nodata values in watertable csv file

Fixed

  • Fix minor bug in production method of progressive reservoir

  • Fix bug when delaying river flow

  • Fix problem when writing unbounded parameter in toml

  • Fix potential bug in water budget when using overflow

  • Fix potential bug in the linked parameters implementation

  • Fix memory leaks in vectors of C++ wrappers

[0.0.4] - 2024-12-19

Added

  • New variables keywords in get_budget simulation method

  • New only_level keywords in set_states simulation method

Changed

  • Package renamed to “rameau”

  • API datetime return None by default

  • Change starting_date input format to 1900-01-01 by default

  • Float values allowed as parameter when building objects

  • Move forecast emission dates value in forecast outputs

  • No correction when halflife=0 for a specific watershed

Fixed

  • Fix big bug with leapyear when issuing a forecast…

[0.0.3] - 2024-10-02

Added

  • Sphinx documentation

  • Add a get_budget method to simulation

  • Add historical riverflow in states

  • Add a to_file method to dump states collection

  • Add a from_file method to load states collection

  • Add states_final attribute to Simulation

  • Add run method to Simulation

  • Add get_states method to Simulation

  • Add set_states method to Simulation

  • Add get_input method to Simulation that return weighted average of input collection related to meteo zones and weights

Changed

  • get_input method in model return unmodified input collection

  • Remove useless csv_file in gardenia parser

  • Refactoring of some Fortran/C++ wrappers

  • Refactor internal fortran forecast and optimization settings

Fixed

  • Fix various leak memories

  • Default time step to one day if single date in meteorological data

  • Fix possible incorrect observation in forecast halflife correction

  • Propagation time is no more applied to river pumping

  • Fix bug related to fortran memory allocation in simulation

[0.0.2] - 2024-07-03

Added

  • Add support for international format date in input files

  • Add an help to the executable version

  • Add a Gardenia parser for version 8.8.*

Changed

  • Remove unused keys in regression parameters when writing to toml

  • Optional csv file for tree in toml file when only one watershed is required

  • Blank space interpreted as empty string in toml file paths

  • Now only constant time step allowed.

  • Improve base level determination during optimization using linear regression

  • Multiply storage coefficient by 10 during optimization by Rosenbrock (from gardenia 8.8)

  • Improve the conversion from eros v7.3

Fixed

  • Confluence basin taken into account in the simulation

  • Fix runtime error when writing files with executable

  • Fix static linking with gcc for windows executable

  • Fix minor bugs related to optimization

[0.0.1] - 2024-04-17

First tag.