Changeset 4878

Timestamp:

Dec 7, 2007, 11:01:45 AM (17 years ago)

Author:

nick

Message:

updated doc string of csv2timeseries_graphs

File:

• anuga_core/source/anuga/abstract_2d_finite_volumes/util.py (modified) (4 diffs)

anuga_core/source/anuga/abstract_2d_finite_volumes/util.py

@@ -1504 +1504 @@
                             verbose=False):
                                 
-    """
-    WARNING!! NO UNIT TESTS... could make some as to test filename..but have
+    """    WARNING!! NO UNIT TESTS... could make some as to test filename..but have
     spend ages on this already...
+    
     
     Read in csv files that have the right header information and
@@ -1556 +1556 @@
         OUTPUTS: None, it saves the plots to 
               <output_dir><base_name><plot_number><extra_plot_name>.png
+
+    Usage:  csv2timeseries_graphs({'J:'+sep+'anuga_validation'+sep:['new',20,-.1],
+                                   'J:'+sep+'conical_island'+sep:['test',0,0]},
+                                   output_dir='',
+                                   plot_numbers=['1','3'],
+                                   quantities=['stage','depth','bearing'],
+                                   base_name='gauge_b',
+                                   assess_all_csv_files=True,
+                                  verbose=True)    
+            This will produce one plot for each quantity (therefore 3) in the current directory, 
+            each plot will have 2 lines on them. The first plot named 'new' will have the time 
+            offseted by 20secs and the stage height adjusted by -0.1m
+
     
     """
-    import pylab# import plot, xlabel, ylabel, savefig, \
-                #ion, hold, axis, close, figure, legend
+    import pylab# 
     from os import sep
     from anuga.shallow_water.data_manager import \
@@ -2282 +2294 @@
         They will all have a header
     
+    Usage: gauges_sww2csv(sww_file='test1.sww',
+               quantities = ['stage', 'elevation','depth','bearing'],
+               gauge_file='gauge.txt')    
+    
     Interpolate the quantities at a given set of locations, given
     an sww file.
@@ -2293 +2309 @@
 
     This is really returning speed, not velocity.
+    
+    
     """
     from csv import reader,writer