Changeset 5783

Timestamp:

Sep 25, 2008, 10:39:12 AM (16 years ago)

Author:

sexton

Message:

updated commenting in project file for Perth

File:

• anuga_work/production/perth/project.py (modified) (11 diffs)

anuga_work/production/perth/project.py

@@ -1 +1 @@
 """Common filenames and locations for elevation, meshes and outputs.
-This script is the heart of all scripts in folder
+This script is the heart of all scripts in the folder
 """
 #------------------------------------------------------------------------------
@@ -18 +18 @@
 # Directory setup
 #------------------------------------------------------------------------------
-##Note: INUNDATIONHOME is the inundation directory, not the data directory.
+# Note: INUNDATIONHOME is the inundation directory, not the data directory.
 
 home = getenv('INUNDATIONHOME') + sep +'data'+sep #Sandpit's parent diruser = get_user_name()
@@ -25 +25 @@
 host = get_host_name()
 
-##time stuff
-time = strftime('%Y%m%d_%H%M%S',localtime()) #gets time for new dir
-gtime = strftime('%Y%m%d_%H%M%S',gmtime()) #gets time for new dir
+# 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'
-print 'gtime: ', gtime
 
 #------------------------------------------------------------------------------
@@ -36 +35 @@
 #------------------------------------------------------------------------------
 
-##Changed to reflect the modeled community (also sets up the directory system)
+# this section needs to be updated to reflect the modelled community.
+# Note, the user needs to set up the directory system accordingly
 state = 'western_australia'
 scenario_name = 'perth'
 scenario = 'perth_tsunami_scenario'
-##One or all can be changed each time the run_scenario script is excuted
-tide = 0 #0.6
-#event_number = 27255
+
+# Model specific parameters. One or all can be changed each time the
+# run_scenario script is executed
+tide = 0                #0.6
+#event_number = 27255   # linked to hazard map
 event_number = 27283
-alpha = 0.1
-friction=0.01
-starttime=0
-finaltime=80000 
-
-setup='final'  ## Can replace with trial or basic, this action will thin the mesh
-               ## so that the run script will take less time (hence less acurate) 
+alpha = 0.1             # smoothing parameter for mesh
+friction=0.01           # manning's friction coefficient
+starttime=0             
+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':
@@ -71 +74 @@
 # Output Filename
 #------------------------------------------------------------------------------
-##Important to distiquish each run
+# Important to distinguish each run - ensure str(user) is included!
+# Note, the user is free to include as many parameters as desired
 dir_comment='_'+setup+'_'+str(tide)+'_'+str(event_number)+'_'+ 'alpha' +str(alpha)+'_'+str(user)
 
 #------------------------------------------------------------------------------
-# INPUT DATA
-#------------------------------------------------------------------------------
-
-##ELEVATION DATA## - used in build_perth.py
-## onshore data: format ascii grid with accompaning projection file
+# Input Data
+#------------------------------------------------------------------------------
+
+# elevation data used in build_perth.py
+# onshore data: format ascii grid with accompanying projection file
 onshore_name = 'perth_dli_ext' 
-## island: format ascii grid with accompaning projection file
+# island: format ascii grid with accompanying projection file
 island_name = 'rott_dli_ext' 
 island_name1 = 'gard_dli_ext'
 island_name2 = 'carnac_island_dli_ext'
 island_name3 = 'penguin_dli_ext'
-## coastline: format x,y,elevation (with title)
+# coastline: format x,y,elevation (with title)
 coast_name = 'coastline_perthP.txt'
-## bathymetry: format x,y,elevation (with title)
+# bathymetry: format x,y,elevation (with title)
 offshore_name = 'Perth.txt'
 offshore_name1 = 'Perth_Chart.txt'
@@ -94 +98 @@
 offshore_name3 = 'port_swanriver.txt'
 
-##GAUGES## - used in get_timeseries.py
+# gauges - used in get_timeseries.py
 gauge_name = 'perth.csv'
 gauge_name2 = 'thinned_MGA50.csv'
 
-##BOUNDING POLYGON## -used in build_boundary.py and run_perth.py respectively
-#NOTE: when files are put together must be in sequence - for ease go clockwise!
-#Check the run_perth.py for boundary_tags
-##thinned ordering file from Hazard Map: format index,latitude,longitude (with title)
+# BOUNDING POLYGON - used in build_boundary.py and run_perth.py respectively
+# NOTE: when files are put together the points must be in sequence - for ease go clockwise!
+# Check the run_perth.py for boundary_tags
+# thinned ordering file from Hazard Map: format is index,latitude,longitude (with title)
 order_filename = 'thinned_boundary_ordering.txt'
-##landward bounding points
+#landward bounding points
 landward = 'landward_bounding_polygon.txt'
 
 #------------------------------------------------------------------------------
-# OUTPUT ELEVATION DATA
-#------------------------------------------------------------------------------
-##Output filename for elevation
-## its a combination of all the data put together (utilisied in build_boundary)
+# Output Elevation Data
+#------------------------------------------------------------------------------
+# Output filename for elevation
+# this is a combination of all the data (utilisied in build_boundary)
 combined_name ='perth_combined_elevation'
 combined_smaller_name = 'perth_combined_elevation_smaller'
@@ -128 +132 @@
 
 #------------------------------------------------------------------------------
-# Location of input and output Data
-#------------------------------------------------------------------------------
-##where the input data sits
+# Location of input and output data
+#------------------------------------------------------------------------------
+# where the input data sits
 onshore_in_dir_name = topographies_in_dir + onshore_name
 island_in_dir_name = topographies_in_dir + island_name
@@ -142 +146 @@
 offshore_in_dir_name3 = topographies_in_dir + offshore_name3
 
-##where the output data sits
+# where the output data sits
 onshore_dir_name = topographies_dir + onshore_name
 island_dir_name = topographies_dir + island_name
@@ -154 +158 @@
 offshore_dir_name3 = topographies_dir + offshore_name3
 
-##where the combined file sits
+# where the combined elevation file sits
 combined_dir_name = topographies_dir + combined_name
 combined_smaller_name_dir = topographies_dir + combined_smaller_name
 
-##where the mesh sits (this is created during the run_perth.py)
+# where the mesh sits (this is created during the run_perth.py)
 meshes_dir_name = meshes_dir + scenario_name+'.msh'
 
-#where the boundary order files sit (this is used within build_boundary.py)
+# where the boundary ordering files sit (this is used within build_boundary.py)
 order_filename_dir = boundaries_dir + order_filename
 
-#where the landward points of boundary extent sit (this is used within run_perth.py)
+# where the landward points of boundary extent sit (this is used within run_perth.py)
 landward_dir = boundaries_dir + landward
 
-#where the event sts files sits (this is created during the build_boundary.py)
+# where the event sts files sits (this is created during the build_boundary.py)
 boundaries_dir_event = boundaries_dir + str(event_number) + sep
 boundaries_dir_mux = muxhome
 
-#where the directory of the output filename sits
-output_build_time_dir = output_dir+build_time+dir_comment+sep #used for build_perth.py
-output_run_time_dir = output_dir+run_time+dir_comment+sep #used for run_perth.py
+# where the directory of the output filename sits
+output_build_time_dir = output_dir+build_time+dir_comment+sep   #used for build_perth.py
+output_run_time_dir = output_dir+run_time+dir_comment+sep       #used for run_perth.py
 output_run_time_dir_name = output_run_time_dir + scenario_name  #Used by post processing
 
-#where the directory of the gauges sit
-gauges_dir_name = gauges_dir + gauge_name #used for get_timeseries.py
-gauges_dir_name2 = gauges_dir + gauge_name2 #used for get_timeseries.py
+#w here the directory of the gauges sit
+gauges_dir_name = gauges_dir + gauge_name       #used for get_timeseries.py
+gauges_dir_name2 = gauges_dir + gauge_name2     #used for get_timeseries.py
 
 #------------------------------------------------------------------------------
@@ -184 +188 @@
 #------------------------------------------------------------------------------
 
-#Land, to set the stage/water to be offcoast only
+#Land, to set the initial stage/water to be offcoast only
 poly_mainland = read_polygon(polygons_dir+'initial_condition.csv')
 
-#Initial bounding polygon for data clipping 
+# Initial bounding polygon for data clipping 
 poly_all = read_polygon(polygons_dir+'poly_all.csv')
 res_poly_all = 100000*res_factor
 
-#Area of Interest 1 (Fremantle)
+# Area of Interest 1 (Fremantle)
 poly_aoi1 = read_polygon(polygons_dir+'CBD_coastal.csv')
 res_aoi1 = 500*res_factor
 
-#Area of Interest 2 (Rockingham)
+# Area of Interest 2 (Rockingham)
 poly_aoi2 = read_polygon(polygons_dir+'rockingham_penguin.csv')
 res_aoi2 = 500*res_factor
 
-#Area of Interest 2 (garden Island)
+# Area of Interest 2 (garden Island)
 poly_aoi2a = read_polygon(polygons_dir+'garden.csv')
 res_aoi2a= 500*res_factor
 
-#Area of Interest 3 (geordie bay - record of tsunami impact)
+# Area of Interest 3 (geordie bay - record of tsunami impact)
 poly_aoi3 = read_polygon(polygons_dir+'geordie_bay.csv')
 res_aoi3 = 500*res_factor
 
-#Area of Interest 4 (sorrento - record of tsunami impact)
+# Area of Interest 4 (sorrento - record of tsunami impact)
 poly_aoi4 = read_polygon(polygons_dir+'sorrento_gauge.csv')
 res_aoi4 = 500*res_factor
 
-#Area of Significance 1 (Garden Island and sand bank infront of Rockingham)
+# Area of Significance 1 (Garden Island and sand bank infront of Rockingham)
 poly_aos1 = read_polygon(polygons_dir+'garden_rockingham.csv')
 res_aos1 = 1000*res_factor
 
-#Area of Significance 2 (incorporate coastline of rottnest)
+# Area of Significance 2 (incorporate coastline of rottnest)
 poly_aos2 = read_polygon(polygons_dir+'rottnest_external.csv')
 res_aos2 = 1000*res_factor
 
-#Refined areas
-#Polygon designed to incorporate Dredge Area from Fremantle to
-#Rockingham the steep incline was making the mesh go to 0
+# Refined areas
+# Polygon designed to incorporate dredged area from Fremantle to
+# Rockingham as the steep incline was making the elevation go to 0
 poly_aos3 = read_polygon(polygons_dir+'DredgeArea.csv')
 res_aos3 = 1000*res_factor
 
-#Shallow water 1
+# Shallow water 1
 poly_sw1 = read_polygon(polygons_dir+'internal_h20mORd3km.csv')
 res_sw1 = 25000*res_factor
 
-#Deep water (land of Rottnest, ANUGA does not do donuts!)
+# Deep water (land of Rottnest, ANUGA does not do donuts!)
 poly_dw1 = read_polygon(polygons_dir+'rottnest_internal.csv')
 res_dw1 = 100000*res_factor
@@ -244 +248 @@
 print 'min estimated number of triangles', trigs_min
    
-
 #------------------------------------------------------------------------------
 # Clipping regions for export to asc and regions for clipping data
+# Final inundation maps should only be created in regions of the finest mesh
 #------------------------------------------------------------------------------