.. currentmodule:: rameau.core
.. default-role:: obj

=============
API Reference
=============

Model
=====

.. autosummary::
   :toctree: ./api/classes

   Model

Inputs
======

.. autosummary::
   :toctree: ./api/classes

   FilePaths

   inputs.InputCollection

   inputs.Input

   inputs.InputFormat

Settings
========

.. autosummary::
   :toctree: ./api/classes

   SimulationSettings

   SpinupSettings

   OptimizationSettings

   ForecastSettings

   OutputSettings

Tree
====

.. autosummary::
   :toctree: ./api/classes

   Tree

   Watershed

Parameters
==========

.. autosummary::
   :toctree: ./api/classes

   Parameter

   Meteo

   CorrectionParameters

   RiverParameters

   ProgressiveReservoir

   ThornthwaiteReservoir

   TransferReservoir

   OverflowParameters

   groundwater.GroundwaterParameters

   groundwater.GroundwaterReservoir

   groundwater.StorageParameters

   snow.SnowReservoir

   snow.SnowCorrectionParameters

   snow.DegreeDayParameters

   pumping.Pumping

   pumping.PumpingReservoir

   Influence

Simulation
==========

.. autosummary::
   :toctree: ./api/classes

   simulation.Simulation

   simulation.OptiSimulation

   simulation.ForecastSimulation

States
======

.. autosummary::
   :toctree: ./api/classes

   states.StatesCollection

   states.States