diff options
| -rw-r--r-- | szilagyi/__init__.py | 10 |
1 files changed, 5 insertions, 5 deletions
diff --git a/szilagyi/__init__.py b/szilagyi/__init__.py index 6281a95..3e91936 100644 --- a/szilagyi/__init__.py +++ b/szilagyi/__init__.py @@ -1,7 +1,6 @@ """ -This package provides a software implementation of an approximation of the Szilagyi Waterspout Index. The calculated -values for SWI are continuous. The wind-speed at 850 hPa is ignored as the nomogram dictates it as a simple on/off -criterion. +This is a software implementation of an approximation of the Szilagyi Waterspout Index. The calculated values of the SWI +are continuous. The wind-speed at 850 hPa is ignored as the nomogram dictates it as a simple on/off criterion. There is only one function provided, so the use should be straight-forward. For example:: @@ -19,9 +18,10 @@ from ._nomogram import MAX_TEMPERATURE_DIFFERENCE, MAX_CONVECTIVE_CLOUD_DEPTH def calculate_swi(temperature_difference, convective_cloud_depth): """ Calculates the Szilagyi Waterspout Index for *temperature_difference* and *convective_cloud_depth*. These are - expected to be respectively: Celsius degrees, and feet. + expected to be expressed in Celsius degrees and feet, respectively. - May raise :exc:`ValueError` if the values are not in range of the original nomogram. + Function will raise ValueError if one of the values is not in range of the original nomogram. The maximum values are + available as MAX_TEMPERATURE_DIFFERENCE and MAX_CONVECTIVE_CLOUD_DEPTH constants. """ if temperature_difference < 0 or temperature_difference > MAX_TEMPERATURE_DIFFERENCE: raise ValueError(f"temperature_difference must be within <0, {MAX_TEMPERATURE_DIFFERENCE}> range") |