Changeset 3623

Timestamp:

Sep 19, 2006, 3:21:56 PM (17 years ago)

Author:

jack

Message:

Moved the run_offline.py into the examples directory.

Location:

anuga_core/source/anuga

Files:

• examples/run_offline.py (moved) (moved from anuga_core/source/anuga/visualiser/run_offline.py) (1 diff)
• visualiser/__init__.py (modified) (1 diff)

anuga_core/source/anuga/examples/run_offline.py

@@ -1 @@
-from offline import OfflineVisualiser
+##########
+# Demonstration of the VTK sww Visualiser
+# Jack Kelly
+# September 2006
+##########
 
+# Import the offline visualiser
+from anuga.visualiser import OfflineVisualiser
+
+# The argument to OfflineVisualiser is the path to a sww file
 o = OfflineVisualiser("../../swollen_viewer/tests/cylinders.sww")
-#o = OfflineVisualiser("../../../../swollen_viewer/tests/karratha_100m.sww")
+
+# Specify the height-based-quantities to render.
+# Remember to set dynamic=True for time-varying quantities
 o.render_quantity_height("elevation", dynamic=False)
 o.render_quantity_height("stage", dynamic=True)
+
+# Colour the stage:
+# Either with an RGB value as a 3-tuple of Floats,
 #o.colour_height_quantity('stage', (0.0, 0.0, 0.8))
+# Or with a function of the quantities at that point, such as the stage height:
+# 0 and 10 are the minimum and maximum values of the stage.
 o.colour_height_quantity('stage', (lambda q:q['stage'], 0, 10))
+# Or with the magnitude of the momentum at that point:
+# Needs the sqrt function from Numeric. Again, 0 and 10 define the colour range.
+#o.colour_height_quantity('stage', (lambda q:sqrt((q['xmomentum'] ** 2) +
+#                                                 (q['ymomentum'] ** 2)), 0, 10))
+
+# Precaching the height-based quantities reduces the time taken to draw each
+# frame, but increases the time taken when the visualiser starts.
 o.precache_height_quantities()
+
+# Start the visualiser (in its own thread).
 o.run()

anuga_core/source/anuga/visualiser/__init__.py

@@ -1 @@
-from vtk_realtime_visualiser import *
-
+from realtime import RealtimeVisualiser
+from offline import OfflineVisualiser
+from visualiser import Visualiser