source: trunk/ga_docs/requirements/plotting_module_requirements.txt @ 7935

Last change on this file since 7935 was 2713, checked in by ole, 18 years ago

Comments regarding plotting module requirements

File size: 2.8 KB
Line 
1Requirements for module to plot time series data after simulation run.
2
331 March 2006
4
5
6
71.      The module shall read a SWW file and plot the time series for the prescribed quantities at defined gauge locations.
8
91.1     The prescribed quantities must be a name of an existing quantity or an expression involving existing quantities.
101.1.1   The default quantity will be 'depth'.
111.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'].
121.1.3   Absolute momentum ('momentum') will be calculated as sqrt(xmomentum^2 + ymomentum^2).
131.1.4   Velocity should be calculated as absolute momentum divided (pointwise) by depth.
141.1.5   Bearing should return the angle of the momentum vector (xmomentum, ymomentum) from the North direction.
15
161.2     The gauge locations should either be defined in a separate file in which case the plotting function is
17        invoked with the name of the file, or they should be provided as an argument in the form of a Numeric array
18        or a structure that can be converted to a Numeric array.
191.2.1   The gauges file should contain the gauge name and location defined in eastings and northings.
201.2.2   The gauge file should be a comma separated file.
21
221.3     The module should be contained in data_manager.py (I think it should be a new module (Ole))
231.3.1   The output should be available both as data and graphics.
241.3.2   The default output shall be graphics.
251.3.3   The output should optionally be computed for a prescribed time range.
261.3.4   The default time range is the complete time series.
271.3.5   The output should be stored in the same directory as the SWW file.
28   
291.4     A latex document should be automatically generated which contains the output graphics.
301.4.1   The caption of the output graphics should contain the gauge name and other simulation parameters.
31
32The outline of the module is as follows:
33
34def sww2timeseries(swwfile,
35                   gauge_filename,   (or a structure that contains that info, e.g. based on Geospatial_data)
36                   gauge_data_outname,
37                   quantity = None,
38                   time_min = None,
39                   time_max = None,
40                   verbose = False):
41
42    # extract gauge locations from gauge file
43   
44    # extract all quantities from sww file
45   
46    # loop through appropriate range of time
47   
48    # plot prescribed quantities and export data if requested
49   
50
51    return
52
53
54where
55
56swwfile defines the input sww file
57gauge_filename defines the gauge (name, easting, northing)
58gauge_data_outname defined the name of the output data file (if required)
59time_min defines the beginning of the time range
60time_max defines the end of the time range
Note: See TracBrowser for help on using the repository browser.