source: anuga_work/production/australia_ph2/melbourne_east/project.py @ 6982

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