check_residual_clip

cosipy.modules.surfaceTemperature.check_residual_clip(residual, lower_bound)

Raise error if the surface temperature is out of bounds.

Parameters:

• residual (float or np.ndarray) – Residual from minimisation.

• lower_bound (float) – Minimum allowable surface temperature.

Returns:

True if surface temperature solution is within bounds.

Raises:

ValueError – Surface temperature solution is out of bounds.

Return type:

bool