Changeset 2713

Timestamp:

Apr 12, 2006, 11:03:54 PM (19 years ago)

Author:

ole

Message:

Comments regarding plotting module requirements

File:

• documentation/requirements/plotting_module_requirements.txt (modified) (2 diffs)

documentation/requirements/plotting_module_requirements.txt

@@ -9 +9 @@
 1.1     The prescribed quantities must be a name of an existing quantity or an expression involving existing quantities.
 1.1.1   The default quantity will be 'depth'.
-1.1.2   The user can define a list of quantities. The possibilities are the conserved quantitues of the shallow water wave equation and other quantities which can be derived from those, i.e.['depth', 'xmomentum', 'ymomentum', 'momentum', 'velocity', 'bearing'].
-1.1.3   Velocity should be calculated as absolute momentum divided by depth.
-1.1.4   Absolute momentum should be calculated as sqrt(xmomentum^2 + ymomentum^2).
-1.1.5   Bearing should return the angle of the velocity vector from North.
+1.1.2   The user can define a list of quantities. The possibilities are the conserved quantitues of the shallow water wave equation and other quantities which can be derived from those, i.e. ['stage', 'depth', 'xmomentum', 'ymomentum', 'momentum', 'velocity', 'bearing'].
+1.1.3   Absolute momentum ('momentum') will be calculated as sqrt(xmomentum^2 + ymomentum^2).
+1.1.4   Velocity should be calculated as absolute momentum divided (pointwise) by depth.
+1.1.5   Bearing should return the angle of the momentum vector (xmomentum, ymomentum) from the North direction.
 
-1.2     The gauge locations should be defined in a separate file.
+1.2     The gauge locations should either be defined in a separate file in which case the plotting function is 
+        invoked with the name of the file, or they should be provided as an argument in the form of a Numeric array 
+        or a structure that can be converted to a Numeric array.
 1.2.1   The gauges file should contain the gauge name and location defined in eastings and northings.
 1.2.2   The gauge file should be a comma separated file.
 
-1.3     The module should be contained in data_manager.py
-1.3.1   The output should be available as data and graphics.
+1.3     The module should be contained in data_manager.py (I think it should be a new module (Ole))
+1.3.1   The output should be available both as data and graphics.
 1.3.2   The default output shall be graphics.
-1.3.3   The output should be available for a prescribed time range.
+1.3.3   The output should optionally be computed for a prescribed time range.
 1.3.4   The default time range is the complete time series.
 1.3.5   The output should be stored in the same directory as the SWW file.
@@ -31 +33 @@
 
 def sww2timeseries(swwfile,
-                   gauge_filename,
+                   gauge_filename,   (or a structure that contains that info, e.g. based on Geospatial_data)
                    gauge_data_outname,
                    quantity = None,