pastas.stressmodels.RechargeModel.get_water_balance
===================================================

.. py:method:: pastas.stressmodels.RechargeModel.get_water_balance(p: pastas.typing.ArrayLike | None = None, tmin: pandas.Timestamp | str | None = None, tmax: pandas.Timestamp | str | None = None, freq: str | None = None) -> pandas.DataFrame

   
   Method to obtain the water balance components.

   :param p: array_like object with the values as floats representing the model
             parameters.
   :type p: array_like, optional
   :param tmin: A string or pandas.Timestamp with the start date for the period
                (E.g. '1980-01-01 00:00:00'). Strings are converted to
                pandas.Timestamp internally.
   :type tmin: pandas.Timestamp or str, optional
   :param tmax: A string or pandas.Timestamp with the end date for the period
                (E.g. '2020-01-01 00:00:00'). Strings are converted to
                pandas.Timestamp internally.
   :type tmax: pandas.Timestamp or str, optional
   :param freq:
   :type freq: string, optional

   :returns: **wb** -- Dataframe with the water balance components, both fluxes and states.
   :rtype: pandas.DataFrame

   .. rubric:: Notes

   This method return a data frame with all water balance components, fluxes and
   states. All ingoing fluxes have a positive sign (e.g., precipitation) and all
   outgoing fluxes have negative sign (e.g., recharge).

   .. warning:: This is an experimental method and may change in the future.

   .. rubric:: Examples

   >>> sm = ps.RechargeModel(prec, evap, ps.Gamma(), ps.rch.FlexModel(),
   >>>                       name="rch")
   >>> ml.add_stressmodel(sm)
   >>> ml.solve()
   >>> wb = sm.get_water_balance(ml.get_parameters("rch"))
   >>> wb.plot(subplots=True)















   ..
       !! processed by numpydoc !!