Changeset 1905 for inundation/pyvolution

Timestamp:

Oct 13, 2005, 11:39:19 AM (20 years ago)

Author:

ole

Message:

Better docstring in file_function

File:

• inundation/pyvolution/util.py (modified) (1 diff)

inundation/pyvolution/util.py

@@ -140 +140 @@
     a callable object.
 
-    If the file has extension 'sww' then it is assumed to be spatio-temporal
-    or temporal and the callable object will have the form f(t,x,y) or f(t)
-    depending on whether the file contains spatial data
-
-    If the file has extension 'tms' then it is assumed to be temporal only
-    and the callable object will have the form f(t)
-
-    Either form will return interpolated values based on the input file
-    using the underlying interpolation_function.
-
-    If domain is specified, model time (domain.starttime)
-    will be checked and possibly modified.
-    
-    All times are assumed to be in UTC
-
-    All spatial information is assumed to be in absolute UTM coordinates.
-
+    Input variables:
+    
+    filename - Name of sww or tms file
+       
+       If the file has extension 'sww' then it is assumed to be spatio-temporal
+       or temporal and the callable object will have the form f(t,x,y) or f(t)
+       depending on whether the file contains spatial data
+
+       If the file has extension 'tms' then it is assumed to be temporal only
+       and the callable object will have the form f(t)
+
+       Either form will return interpolated values based on the input file
+       using the underlying interpolation_function.
+
+    domain - Associated domain object   
+       If domain is specified, model time (domain.starttime)
+       will be checked and possibly modified.
+    
+       All times are assumed to be in UTC
+       
+       All spatial information is assumed to be in absolute UTM coordinates.
+
+    quantities - the name of the quantity to be interpolated or a
+                 list of quantity names. The resulting function will return
+                 a tuple of values - one for each quantity  
+
+    interpolation_points - list of absolute UTM coordinates for points at
+    which values are sought
+    
+
+    
     See Interpolation function for further documentation
     """