pastas.model.Model.get_tmin#
- Model.get_tmin(tmin=None, use_oseries=True, use_stresses=False)[source]#
Method that checks and returns valid values for tmin.
- Parameters:
tmin (str or pandas.Timestamp, optional) – string with a year or date that can be turned into a pandas Timestamp ( e.g. pd.Timestamp(tmin)).
use_oseries (bool, optional) – Obtain the tmin and tmax from the oseries. Default is True.
use_stresses (bool, optional) – Obtain the tmin and tmax from the stresses. The minimum/maximum time from all stresses is taken.
- Returns:
tmin – returns pandas timestamps for tmin.
- Return type:
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:
If no value for tmin is provided:
If the use_oseries argument is True, tmin is based on the oseries.
If the use_stresses argument is True, tmin is based on the stressmodels.
If a values for tmin is provided:
A pandas timestamp is made from the string
If the use_oseries argument is True, tmin is checked against oseries.