pastas.timer.SolveTimer
=======================

.. toctree::
   :hidden:

   /api/pastas/timer/SolveTimer.timer

.. py:class:: pastas.timer.SolveTimer(*args, max_time: float | None = None, **kwargs)



   
   Progress indicator for model optimization.

   .. rubric:: Examples

   Print timer and number of iterations in console while running `ml.solve()`::

       with SolveTimer() as t:
           ml.solve(callback=t.timer)

   This prints the following to the console, for example::

       Optimization progress: 73it [00:01, 67.68it/s]

   .. rubric:: Notes

   If the logger is also printing messages to the console the timer will not be
   updated quite as nicely.















   ..
       !! processed by numpydoc !!
Methods
-------

.. autoapisummary::

   pastas.timer.SolveTimer.timer