pastas.model.Model.get_tmax
===========================

.. py:method:: pastas.model.Model.get_tmax(tmax: pandas.Timestamp | str | None = None, use_oseries: bool = True, use_stresses: bool = False) -> pandas.Timestamp

   
   Method that checks and returns valid values for tmax.

   :param tmax: A string or pandas.Timestamp that can be turned into a pandas Timestamp
                (e.g. '2020-01-01 00:00:00'). Strings are converted to pandas.Timestamp
                internally.
   :type tmax: pandas.Timestamp or str, optional
   :param use_oseries: Obtain the tmin and tmax from the oseries. Default is True.
   :type use_oseries: bool, optional
   :param use_stresses: Obtain the tmin and tmax from the stresses. The minimum/maximum time from
                        all stresses is taken.
   :type use_stresses: bool, optional

   :returns: **tmax** -- returns pandas timestamps for tmax.
   :rtype: pandas.Timestamp

   .. rubric:: Notes

   The parameters tmin and tmax are leading, unless use_oseries is True,
   then these are checked against the oseries index. The tmin and tmax are
   checked and returned according to the following rules:

   A. If no value for tmax is provided:

       1. If the use_oseries argument is True, tmax is based on the oseries.
       2. If the use_stresses argument is True, tmax is based on the stressmodels.

   B. If a values for tmax is provided:

       1. A pandas timestamp is made from the string.
       2. if the use_oseries argument is True, tmax is checked against oseries.

   A detailed description of dealing with tmax and timesteps in general can be
   found in the developers section of the docs.















   ..
       !! processed by numpydoc !!