Changeset 6308

Timestamp:

Feb 10, 2009, 2:27:54 PM (16 years ago)

Author:

rwilson

Message:

Major fiddle to get this into a more user-friendly form.

File:

• anuga_work/production/busselton/standardised_version/project.py (modified) (9 diffs)

anuga_work/production/busselton/standardised_version/project.py

@@ -1 @@
-"""Common filenames and locations for elevation, meshes and outputs.
+"""
+Common filenames and locations for elevation, meshes and outputs.
 This script is the heart of all scripts in the folder
 """
-#------------------------------------------------------------------------------
-# Import necessary modules
-#------------------------------------------------------------------------------
-
+
+import sys
 import os
-from os.path import join
-from os import sep, getenv
+from os.path import join, exists
 from time import localtime, strftime, gmtime
 from anuga.utilities.polygon import read_polygon, number_mesh_triangles
 from anuga.utilities.system_tools import get_user_name, get_host_name
 
-#------------------------------------------------------------------------------
-# Directory setup
-#------------------------------------------------------------------------------
-# Note: INUNDATIONHOME is the inundation directory, not the data directory.
-
-home = getenv('INUNDATIONHOME')+sep+'data'+sep # Absolute path for data folder
-muxhome = getenv('MUXHOME')
+
+#-----
+# Get system data - don't fiddle with this.
+#-----
+
 user = get_user_name()
 host = get_host_name()
 
-# determines time for setting up output directories
-time = strftime('%Y%m%d_%H%M%S',localtime()) 
-gtime = strftime('%Y%m%d_%H%M%S',gmtime()) 
-build_time = time+'_build'
-run_time = time+'_run'
+#-------------------------------------------------------------------------------
+# Directory setup
+#-------------------------------------------------------------------------------
 
 # this section needs to be updated to reflect the modelled community.
@@ -35 +29 @@
 scenario_folder = 'busselton_tsunami_scenario'
 
-#------------------------------------------------------------------------------
+#-------------------------------------------------------------------------------
 # Initial Conditions
-#------------------------------------------------------------------------------
-# Model specific parameters. One or all can be changed each time the
-# run_scenario script is executed
-tide = 0              #0.6
-event_number = 27255 # Java 9.3 worst case for Perth
-#event_number = 68693 # Sumatra 9.2
-#event_number = 27283  # Java 9.3 original
-tide = 0                #0.6
-#event_number = 27255   # Java 9.3 worst case for Perth
-#event_number = 68693   # Sumatra 9.2
-event_number = 27283    # Java 9.3 original
+#-------------------------------------------------------------------------------
+
+# Model specific parameters.
+# One or all can be changed each time the run_model script is executed
+tide = 0                # ??
+event_number = 27283    # the event number
 alpha = 0.1             # smoothing parameter for mesh
 friction=0.01           # manning's friction coefficient
-starttime=0             
+starttime=0             # start time for simulation
 finaltime=80000         # final time for simulation
 
-setup='final'  # Final can be replaced with trial or basic.
-               # Either will result in a coarser mesh that will allow a
-               # faster, but less accurate, simulation.
-
-if setup =='trial':
-    print'trial'
-    scale_factor=100
-    time_thinning=96
-    yieldstep=240
-if setup =='basic': 
-    print'basic'
-    scale_factor=4
-    time_thinning=12
-    yieldstep=120
-if setup =='final': 
-    print'final'
-    scale_factor=1
-    time_thinning=4
-    yieldstep=60
-
-
-#------------------------------------------------------------------------------
+setup = 'final'  # Final can be replaced with trial or basic.
+                 # Either will result in a coarser mesh that will
+                 # allow a faster, but less accurate, simulation.
+
+#-------------------------------------------------------------------------------
 # Output Filename
-#------------------------------------------------------------------------------
+#-------------------------------------------------------------------------------
+
 # Important to distinguish each run - ensure str(user) is included!
 # Note, the user is free to include as many parameters as desired
-output_comment= ('_' + setup + '_' + str(tide)+ '_' + str(event_number) +
-                 '_' + str(user))
-
-#------------------------------------------------------------------------------
+output_comment = '_'.join([setup, str(tide), str(event_number), str(user)])
+
+#-------------------------------------------------------------------------------
 # Input Data
-#------------------------------------------------------------------------------
+#-------------------------------------------------------------------------------
+
 # ELEVATION DATA
 # Used in build_elevation.py
@@ -92 +65 @@
 
 # Format for point is x,y,elevation (with header)
-point_filenames = ['Busselton_Contour0.txt',     # Coastline
-                   'Busselton_BeachSurvey.txt',    # Beach survey
-                   'Busselton_NavyFinal.txt',  # Bathymetry
-                   'Busselton_Chart.txt', # Bathymetry Charts
-                   'Busselton_Digitised.txt', # Digitised Fairsheet
-                   'Busselton_250m.txt', # 250m
-                   'Bunbury_TIN.txt', # Bunbury aoi TIN'd in ArcGIS
-                   'Busselton_TIN.txt', # Busselton aoi TIN'd in ArcGIS
-                   'XYAHD_clip.txt'] # To extend boundary
-
-
-# LAND - used to set the initial stage/water to be offcoast only
-# Used in run_model,py
-# Format for points easting,northing (no header)
-land_initial_conditions_filename = [['initial_condition_extend.csv', 0],
-                                    ['initial_condition_marina.csv', 0]]
+point_filenames = ['Busselton_Contour0.txt',    # Coastline
+                   'Busselton_BeachSurvey.txt', # Beach survey
+                   'Busselton_NavyFinal.txt',   # Bathymetry
+                   'Busselton_Chart.txt',       # Bathymetry Charts
+                   'Busselton_Digitised.txt',   # Digitised Fairsheet
+                   'Busselton_250m.txt',        # 250m
+                   'Bunbury_TIN.txt',           # Bunbury aoi TIN'd in ArcGIS
+                   'Busselton_TIN.txt',         # Busselton aoi TIN'd in ArcGIS
+                   'XYAHD_clip.txt']            # To extend boundary
 
 # BOUNDING POLYGON - for data clipping and estimate of triangles in mesh
@@ -125 +91 @@
                          ['coast_5km_d20m.csv', 40000]]
 
+# LAND - used to set the initial stage/water to be offcoast only
+# Used in run_model.py.  Format for points easting,northing (no header)
+land_initial_conditions_filename = [['initial_condition_extend.csv', 0],
+                                    ['initial_condition_marina.csv', 0]]
+
 # GAUGES - for creating timeseries at a specific point
-# Used in get_timeseries.py
+# Used in get_timeseries.py.  
 # Format easting,northing,name,elevation (with header)
 gauges_filename = 'gauges.csv'
@@ -135 +106 @@
 building_exposure_filename = 'busselton_res_clip.csv' #from NEXIS
 
-# BOUNDING POLYGON
-# used in build_boundary.py and run_model.py respectively
+# BOUNDING POLYGON - used in build_boundary.py and run_model.py respectively
 # NOTE: when files are put together the points must be in sequence
 # For ease go clockwise!
@@ -149 +119 @@
 landward_boundary_filename = 'landward_boundary_extend.csv'
 
-#------------------------------------------------------------------------------
+# MUX input filename
+# Must exist in $MUXHOME/mux directory.
+# If MUX file not used, do "mux_input_file = None".
+mux_input_file = 'event_031451.list'          # File produced by EventSelection
+
+#-------------------------------------------------------------------------------
 # Clipping regions for export to asc and regions for clipping data
 # Final inundation maps should only be created in regions of the finest mesh
-#------------------------------------------------------------------------------
+#-------------------------------------------------------------------------------
 
 # ASCII export grid for Busselton
@@ -167 +142 @@
 
 
-#------------------------------------------------------------------------------
+################################################################################
+################################################################################
+####             NOTE: NOTHING SHOULD CHANGE BELOW THIS POINT.              ####
+################################################################################
+################################################################################
+
+#-------------------------------------------------------------------------------
+# Sanity checks
+#-------------------------------------------------------------------------------
+
+# Test that environment variables are defined.
+# A little late, but better here than up in user-changeable data.
+
+# Environment variable names.
+# The inundation directory, not the data directory.
+ENV_INUNDATIONHOME = 'INUNDATIONHOME'
+
+# Path to MUX data
+ENV_MUXHOME = 'MUXHOME'
+
+# Check we have required environment variables set
+sanity_error = False               # checked at bottom of this file
+
+if os.getenv(ENV_INUNDATIONHOME) is None:
+    print "Environment variable '%s' is not set" % ENV_INUNDATIONHOME
+    sanity_error = True
+
+if os.getenv(ENV_MUXHOME) is None:
+    print "Environment variable '%s' is not set" % ENV_MUXHOME
+    sanity_error = True
+
+# check for errors detected so far
+if sanity_error:
+    print 'You must fix the above errors before continuing.'
+    sys.exit(10)
+
+#-------------------------------------------------------------------------------
 # Output Elevation Data
-#------------------------------------------------------------------------------
+#-------------------------------------------------------------------------------
+
 # Output filename for elevation
 # this is a combination of all the data generated in build_elevation.py
 combined_elevation_basename = scenario_name + '_combined_elevation'
 
-#------------------------------------------------------------------------------
+#-------------------------------------------------------------------------------
 # Directory Structure
-#------------------------------------------------------------------------------
+#-------------------------------------------------------------------------------
+
+# determines time for setting up output directories
+time = strftime('%Y%m%d_%H%M%S', localtime()) 
+gtime = strftime('%Y%m%d_%H%M%S', gmtime()) 
+build_time = time + '_build'
+run_time = time + '_run'
+
+# create paths generated from environment variables.
+home = join(os.getenv(ENV_INUNDATIONHOME), 'data') # Absolute path for data folder
+if not exists(home):
+    print "Sorry, data directory '%s' doesn't exist" % home
+    sanity_error = True
+    
+muxhome = os.getenv(ENV_MUXHOME)
+if not exists(muxhome):
+    print "Sorry, MUX directory '%s' doesn't exist" % muxhome
+    sanity_error = True
+    
+# if mux_input_file has been defined, check if file exists
+if mux_input_file:
+    if not exists(join(muxhome, mux_input_file)):
+        print ("Sorry, MUX input file '%s' doesn't exist"
+               % join(muxhome, mux_input_file))
+        sanity_error = True
+
+# check various directories that must exist
 anuga_folder = join(home, state, scenario_folder, 'anuga')
+if not exists(anuga_folder):
+    print "Sorry, ANUGA directory '%s' doesn't exist" % anuga_folder
+    sanity_error = True
+
 topographies_folder = join(anuga_folder, 'topographies')
+if not exists(topographies_folder):
+    print "Sorry, topo directory '%s' doesn't exist" % topographies_folder
+    sanity_error = True
+
 polygons_folder = join(anuga_folder, 'polygons')
+if not exists(polygons_folder):
+    print "Sorry, polygon directory '%s' doesn't exist" % polygons_folder
+    sanity_error = True
+
 boundaries_folder = join(anuga_folder, 'boundaries')
+if not exists(boundaries_folder):
+    print "Sorry, boundaries directory '%s' doesn't exist" % boundaries_folder
+    sanity_error = True
+
 output_folder = join(anuga_folder, 'outputs')
-gauges_folder = join(anuga_folder,'gauges')
+if not exists(output_folder):
+    print "Sorry, outputs directory '%s' doesn't exist" % output_folder
+    sanity_error = True
+
+gauges_folder = join(anuga_folder, 'gauges')
+if not exists(gauges_folder):
+    print "Sorry, gauges directory '%s' doesn't exist" % gauges_folder
+    sanity_error = True
+
 meshes_folder = join(anuga_folder, 'meshes')
-
-#------------------------------------------------------------------------------
+if not exists(meshes_folder):
+    print "Sorry, meshes directory '%s' doesn't exist" % meshes_folder
+    sanity_error = True
+
+
+#-------------------------------------------------------------------------------
 # Location of input and output data
-#------------------------------------------------------------------------------
+#-------------------------------------------------------------------------------
 
 # The absolute pathname of the all elevation, generated in build_elevation.py
 combined_elevation = join(topographies_folder, combined_elevation_basename)
-
 
 # The absolute pathname of the mesh, generated in run_model.py
@@ -222 +287 @@
 building_exposure = join(gauges_folder, building_exposure_filename)
 
-#------------------------------------------------------------------------------
+#-------------------------------------------------------------------------------
+# Determine type of run
+#-------------------------------------------------------------------------------
+
+if setup == 'trial':
+    print 'trial'
+    scale_factor = 100
+    time_thinning = 96
+    yieldstep = 240
+elif setup == 'basic': 
+    print 'basic'
+    scale_factor = 4
+    time_thinning = 12
+    yieldstep = 120
+elif setup == 'final': 
+    print 'final'
+    scale_factor = 1
+    time_thinning = 4
+    yieldstep = 60
+else:
+    print ("Sorry, you must set the 'setup' variable to one of 'trial', "
+           "'basic' or 'final'. I found '%s'" % str(setup))
+    sanity_error = True
+
+#-------------------------------------------------------------------------------
 # Reading polygons and creating interior regions
-#------------------------------------------------------------------------------
+#-------------------------------------------------------------------------------
 
 # Create list of land polygons with initial conditions
@@ -246 +335 @@
 trigs_min = number_mesh_triangles(interior_regions,
                                   bounding_polygon, bounding_maxarea)
+
+#-------------------------------------------------------------------------------
+# Check for errors detected above.
+#-------------------------------------------------------------------------------
+
+if sanity_error:
+    print 'You must fix the above errors before continuing.'
+    sys.exit(10)
+
+
 print 'min estimated number of triangles', trigs_min
-   
-