source: anuga_work/production/australia_ph2/melbourne/project.py @ 6799

Last change on this file since 6799 was 6799, checked in by kristy, 15 years ago

change project.py to reflect 'simple' model

File size: 10.4 KB
Line 
1"""
2This file contains all your file and directory definitions
3for elevation, meshes and outputs.
4"""
5
6import os
7from anuga.utilities.system_tools import get_user_name, get_host_name
8from time import localtime, strftime, gmtime
9from os.path import join, exists
10from anuga.lib.add_csv_header.add_csv_header import add_csv_header
11
12#-------------------------------------------------------------------------------
13# Directory setup
14#-------------------------------------------------------------------------------
15
16# this section needs to be updated to reflect the modelled community.
17# Note, the user needs to set up the directory system accordingly
18state = 'australia_ph2'
19scenario_name = 'melbourne'
20
21#-------------------------------------------------------------------------------
22# Initial Conditions
23#-------------------------------------------------------------------------------
24
25# Model specific parameters.
26# One or all can be changed each time the run_model script is executed
27import sys
28if len(sys.argv) > 1:
29    event_number = int(sys.argv[1])
30else:   
31    event_number = 58348    # the event number or the mux file name
32
33event_side = 'west' #'east'
34if event_side == 'west':
35    index = 1979 # index from the PTHA - Y2000 0.257m
36    event_number_list = [58348, 64288, 68793] # To piggy back multiple events
37
38elif event_side == 'east':
39    index = 2649 
40    event_number_list = [31853, 51449, 58115] # To piggy back multiple events
41
42central_meridian = 146.0 # Central meridian for projection (optional)
43zone = None
44tide = 0                # difference between MSL and HAT
45alpha = 0.1             # smoothing parameter for mesh
46friction=0.01           # manning's friction coefficient
47starttime=0             # start time for simulation
48finaltime=60000         # final time for simulation
49setup = 'final'         # This can be one of three values
50                        #    trial - coarsest mesh, fast
51                        #    basic - coarse mesh
52                        #    final - fine mesh, slowest
53
54# index is only used when wave = Tb
55           
56wave = 'Tb'         # Bf (sts wave) Tb (index wave)
57
58internal_polygon = False
59
60#-------------------------------------------------------------------------------
61# Output filename
62#
63# Your output filename should be unique between different runs on different data.
64# The list of items below will be used to create a file in your output directory.
65# Your user name and time+date will be automatically added.  For example,
66#     [setup, tide, event_number]
67# will result in a filename like
68#     20090212_091046_run_final_0_27283_rwilson
69#-------------------------------------------------------------------------------
70
71if internal_polygon:
72    internal_poly_comment = 'internal'
73else:
74    internal_poly_comment = ''
75
76output_comment = [setup, tide, event_number, index, wave, event_side, internal_poly_comment]
77
78#-------------------------------------------------------------------------------
79# Input Data
80#-------------------------------------------------------------------------------
81
82# ELEVATION DATA
83# Used in build_elevation.py
84# Format for ascii grids, as produced in ArcGIS + a projection file
85ascii_grid_filenames = ['grid_250m_simple']
86
87# Format for points is x,y,elevation (with header)
88point_filenames = []               #
89
90### Add csv header list to all files in point_filenames
91##headerlist = ['x', 'y', 'elevation']
92##for f in point_filenames:
93##    add_csv_header(join(topographies_folder, f), headerlist)
94
95# BOUNDING POLYGON - for data clipping and estimate of triangles in mesh
96# Used in build_elevation.py
97# Format for points: easting,northing (no header)
98bounding_polygon_filename = 'bounding_polygon.csv'
99bounding_polygon_maxarea = 125000
100
101# INTERIOR REGIONS -  for designing the mesh
102# Used in run_model.py
103# Format for points easting,northing (no header)                   
104interior_regions_data = []
105
106# add an internal polygon to force different mesh generation
107# used to test for discretisation error when building elevation
108# make sure file is in same folder as interior regions and bouding polygon;
109# format is same (2 column .csv; easting, northing; no header)
110if internal_polygon:
111    interior_regions_data.append(['internal_polygon.csv',
112                                  bounding_polygon_maxarea])
113
114# LAND - used to set the initial stage/water to be offcoast only
115# Used in run_model.py.  Format for points easting,northing (no header)
116land_initial_conditions_filename = []
117
118# GAUGES - for creating timeseries at a specific point
119# Used in get_timeseries.py. 
120# Format easting,northing,name,elevation (with header)
121gauges_filename = 'gauges.csv'
122
123# BUILDINGS EXPOSURE - for identifying inundated houses
124# Used in run_building_inundation.py
125# Format latitude,longitude etc (geographic)
126building_exposure_filename = '.csv' # from NEXIS
127
128# BOUNDING POLYGON - used in build_boundary.py and run_model.py respectively
129# NOTE: when files are put together the points must be in sequence
130# For ease go clockwise!
131# Check the run_model.py for boundary_tags
132
133# Thinned ordering file from Hazard Map (geographic)
134# Format is index,latitude,longitude (with header)
135urs_order_filename_W = 'urs_order_west_simple.csv'
136urs_order_filename_E ='urs_order_east_simple.csv'
137##urs_order_filename = 'urs_order_both.csv' # east is first, then west
138
139# Landward bounding points
140# Format easting,northing (no header)
141landward_boundary_filename_N = 'landward_boundary_north.csv'
142landward_boundary_filename_S = 'landward_boundary_south.csv'
143
144# MUX input filename.
145# If a meta-file from EventSelection is used, set 'multi-mux' to True.
146# If a single MUX stem filename (*.grd) is used, set 'multi-mux' to False.
147##mux_input_filename = 'Java-0016-z.grd'
148##multi_mux = False
149mux_input_filename = 'event.list'
150multi_mux = True
151
152# Specify if share cache is to be used
153# Whatever is specified here will be relative to INUNDATION_HOME/.cache
154# If nothing is specified, local cache will be used.
155cachedir = '.python_cache_phII'
156
157
158################################################################################
159################################################################################
160####         NOTE: NOTHING WOULD NORMALLY CHANGE BELOW THIS POINT.          ####
161################################################################################
162################################################################################
163
164# Get system user and host names.
165# These values can be used to distinguish between two similar runs by two
166# different users or runs by the same user on two different machines.
167user = get_user_name()
168host = get_host_name()
169
170# Environment variable names.
171# The inundation directory, not the data directory.
172ENV_INUNDATIONHOME = 'INUNDATIONHOME'
173
174# Path to MUX data
175ENV_MUXHOME = 'MUXHOME'
176
177#-------------------------------------------------------------------------------
178# Output Elevation Data
179#-------------------------------------------------------------------------------
180
181# Output filename for elevation
182# this is a combination of all the data generated in build_elevation.py
183combined_elevation_basename = scenario_name + '_combined_elevation'
184
185#-------------------------------------------------------------------------------
186# Directory Structure
187#-------------------------------------------------------------------------------
188
189# determines time for setting up output directories
190time = strftime('%Y%m%d_%H%M%S', localtime()) 
191gtime = strftime('%Y%m%d_%H%M%S', gmtime()) 
192build_time = time + '_build'
193run_time = time + '_run_'
194
195# create paths generated from environment variables.
196home = join(os.getenv(ENV_INUNDATIONHOME), 'data') # Absolute path for data folder
197muxhome = os.getenv(ENV_MUXHOME)
198
199# Create absolute pathname for cache directory
200# and change caching to use it
201if 'cachedir' in dir():
202    cachedir = join(os.getenv(ENV_INUNDATIONHOME), '.cache', cachedir)
203    from anuga.caching import caching
204    caching.set_option('cachedir', cachedir) 
205   
206# check various directories/files that must exist
207anuga_folder = join(home, state, scenario_name, 'anuga')
208topographies_folder = join(anuga_folder, 'topographies')
209polygons_folder = join(anuga_folder, 'polygons')
210boundaries_folder = join(anuga_folder, 'boundaries')
211output_folder = join(anuga_folder, 'outputs')
212gauges_folder = join(anuga_folder, 'gauges')
213meshes_folder = join(anuga_folder, 'meshes')
214event_folder = join(boundaries_folder, str(event_number))
215
216# MUX data files
217# Directory containing the MUX data files to be used with EventSelection.
218mux_data_folder = join(muxhome, 'mux')
219
220#-------------------------------------------------------------------------------
221# Location of input and output data
222#-------------------------------------------------------------------------------
223
224# Convert the user output_comment to a string for run_model.py
225output_comment = ('_'.join([str(x) for x in output_comment if x != user])
226                  + '_' + user)
227
228# The absolute pathname of the all elevation, generated in build_elevation.py
229combined_elevation = join(topographies_folder, combined_elevation_basename)
230
231# The absolute pathname of the mesh, generated in run_model.py
232meshes = join(meshes_folder, scenario_name) + '.msh'
233
234# The pathname for the urs order points, used within build_urs_boundary.py
235urs_order_east = join(boundaries_folder, urs_order_filename_E)
236urs_order_west = join(boundaries_folder, urs_order_filename_W)
237
238# The absolute pathname for the landward points of the bounding polygon,
239# Used within run_model.py)
240landward_boundary_N = join(boundaries_folder, landward_boundary_filename_N)
241landward_boundary_S = join(boundaries_folder, landward_boundary_filename_S)
242
243# The absolute pathname for the .sts file, generated in build_boundary.py
244event_sts_east = join(event_folder, scenario_name) + '_east'
245event_sts_west = join(event_folder, scenario_name) + '_west'
246
247# The absolute pathname for the output folder names
248# Used for build_elevation.py
249output_build = join(output_folder, build_time) + '_' + str(user) 
250# Used for run_model.py
251output_run = join(output_folder, run_time) + output_comment
252# Used by post processing
253output_run_time = join(output_run, scenario_name) 
254
255# The absolute pathname for the gauges file
256# Used for get_timeseries.py
257gauges = join(gauges_folder, gauges_filename)       
258
259# The absolute pathname for the building file
260# Used for run_building_inundation.py
261building_exposure = join(gauges_folder, building_exposure_filename)
262
263# full path to where MUX files (or meta-files) live
264mux_input = join(event_folder, mux_input_filename)
265
266# sts gauge with desired index number - used for wave 'Tb'
267boundary_csv = join(event_folder, 'sts_gauge_' + str(index) + '.csv')
268
269
Note: See TracBrowser for help on using the repository browser.