diff options
| -rw-r--r-- | szilagyi/__init__.py | 17 |
1 files changed, 16 insertions, 1 deletions
diff --git a/szilagyi/__init__.py b/szilagyi/__init__.py index 5f365e1..426abe4 100644 --- a/szilagyi/__init__.py +++ b/szilagyi/__init__.py @@ -1,9 +1,24 @@ +""" +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. + +There is only one function provided, so the use should be straight-forward. For example:: + + >>> import szilagyi + >>> round(szilagyi.calculate_swi(10.5, 24100), 3) + 0.811 + >>> round(szilagyi.calculate_swi(7, 12500), 3) + -4.88 +""" + from ._nomogram import calculate_swi as _calculate_swi def calculate_swi(temperature_difference, convective_cloud_depth): """ - Calculates the Szilagyi Waterspout Index for *temperature_difference* and *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. May raise :exc:`ValueError` if the values are not in range of the original nomogram. """ |