address #537

[dbrakenhoff]

Short Description

• improve simulation has NaNs msg to include example code for stressmodel settings
• add traps for method is None in fill_before and fill_after, raise ValueError
• avoid issues with trailing or leading NaNs in time series by setting tmin/tmax to first/last valid index
• add more informative error message when weights and observations are not same length
• improve msg formatting

I hope this improves feedback to the user without limiting any functionality. Let me know if I missed any cases...?

Examples

Case with stress starting after oseries. Running ml.solve() yields the following exception:

ValueError: Time Series 'rain': cannot be extended into past to 1975-11-17 00:00:00 as 'fill_before' 
method is 'None'. Provide settings to stress model, e.g. `ps.StressModel(stress, settings='prec')`.

Case with stress ending before oseries. Running ml.solve() yields the following exception:

ValueError: Time Series 'rain': cannot be extended into future to 2015-06-28 00:00:00 as 'fill_after' 
method is 'None'. Provide settings to stress model, e.g. `ps.StressModel(stress, settings='prec')`.

If somehow NaNs still make it into the simulation:

ValueError: Simulation contains NaN-values. Check if time series settings are provided for each stress 
model (e.g. `ps.StressModel(stress, settings='prec')`!

If somehow simulation and observations do not match:

ValueError: Weights and observations time series have different lengths! Check oseries and stresses settings.

Checklist before PR can be merged:

• closes issue [ENHANCEMENT] more informative error when no setting is provided #537
• is documented
• Format code with Black formatting
• type hints for functions and methods
• tests added / passed
• Remove output for all notebooks with changes

[codacy-production]

Coverage summary from Codacy

Merging #599 (16c4dd3) into dev (a7b11cc) - See PR on Codacy

Coverage variation	Diff coverage
❌ -0.15% (target: +0.00%)	38.46%

Coverage variation details

	Coverable lines	Covered lines	Coverage
Common ancestor commit (a7b11cc)	4955	3599	72.63%
Head commit (16c4dd3)	4965 (+10)	3599 (+0)	72.49% (-0.15%)

Coverage variation is the difference between the coverage for the head and common ancestor commits of the pull request branch: <coverage of head commit> - <coverage of common ancestor commit>

Diff coverage details

	Coverable lines	Covered lines	Diff coverage
Pull request (#599)	13	5	38.46%

Diff coverage is the percentage of lines that are covered by tests out of the coverable lines that the pull request added or modified: <covered lines added or modified>/<coverable lines added or modified> * 100%

See your quality gate settings    Change summary preferences