source: anuga_work/production/busselton/standardised_version/project.py @ 6261

"""Common filenames and locations for elevation, meshes and outputs.
This script is the heart of all scripts in the folder
"""
#------------------------------------------------------------------------------
# Import necessary modules
#------------------------------------------------------------------------------

import os
from os import sep, environ, getenv, getcwd
from os.path import expanduser
import sys
from time import localtime, strftime, gmtime
from anuga.utilities.polygon import read_polygon, plot_polygons, is_inside_polygon, number_mesh_triangles
from anuga.utilities.system_tools import get_user_name, get_host_name
from anuga.shallow_water.data_manager import urs2sts,create_sts_boundary
from anuga.utilities.polygon import read_polygon, plot_polygons, polygon_area, is_inside_polygon

#------------------------------------------------------------------------------
# Directory setup
#------------------------------------------------------------------------------
# Note: INUNDATIONHOME is the inundation directory, not the data directory.

home = getenv('INUNDATIONHOME') + sep +'data'+sep #Sandpit's parent diruser = get_user_name()
muxhome = getenv('MUXHOME')
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'

#------------------------------------------------------------------------------
# Initial Conditions
#------------------------------------------------------------------------------

# 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 = 'busselton'
scenario = 'busselton_tsunami_scenario'

# 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
alpha = 0.1             # smoothing parameter for mesh
friction=0.01           # manning's friction coefficient
starttime=0             
finaltime=80000         # final time for simulation

setup='trial'  # 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'
    res_factor=100
    time_thinning=96
    yieldstep=240
if setup =='basic': 
    print'basic'
    res_factor=4
    time_thinning=12
    yieldstep=120
if setup =='final': 
    print'final'
    res_factor=1
    time_thinning=4
    yieldstep=60

#------------------------------------------------------------------------------
# Revision numbers - for comparisons study
#------------------------------------------------------------------------------
rev_num = 'newExtent'
#rev_num = '5449'
#rev_num = '4695' # 2nd Sept 2007
#rev_num = '4743' # 3nd Oct 2007
#rev_num = '4777' # 1st Nov 2007
#rev_num = '4874' # 3rd Dec 2007
#rev_num = '4901' # 3rd Jan 2007
#rev_num = '4990' # 5th Feb 2007
#rev_num = '5103' # 3rd March 2007
#rev_num = '5120' # 5th March 2007
#rev_num = '5140' # 7th March 2007
#rev_num = '5160' # 11th March 2007
#rev_num = '5185' # 1st April 2007
#rev_num = '5273' # 2nd May 2007


#------------------------------------------------------------------------------
# Output Filename
#------------------------------------------------------------------------------
# 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_busselton.py
# onshore data: format ascii grid with accompanying projection file
onshore_name = 'busselton_v2_gda94_mga50' 
# coastline: format x,y,elevation (with title)
coast_name = 'Busselton_Contour0.txt'
coast_name1 = 'Busselton_BeachSurvey.txt'
# bathymetry: format x,y,elevation (with title)
offshore_name = 'Busselton_NavyFinal.txt'
offshore_name1 = 'Busselton_Chart.txt'
offshore_name2 = 'Busselton_Digitised.txt'
offshore_name3 = 'Busselton_250m.txt' # for areas that were heading to zero - 2005 Bathymetry grid
offshore_name4 = 'DPI.txt' # for area within Bunbury 500 mesh less than zero generated from TIN
offshore_name5 = 'topo_20m_buss_1km' # for area within Busselton 500 mesh less than zero generated from TIN

# gauges - used in get_timeseries.py
#gauge_name = scenario_name+'.txt'
gauge_name = 'Gauges.csv'
# buildings - used in run_building_inundation.py
building = 'busselton_res_clip'


# BOUNDING POLYGON - used in build_boundary.py and run_busselton.py respectively
# NOTE: when files are put together the points must be in sequence - for ease go clockwise!
# Check the run_busselton.py for boundary_tags
# thinned ordering file from Hazard Map: format is index,latitude,longitude (with title)
order_filename = 'thinned_boundary_ordering.csv'
#landward bounding points
landward = 'landward_bounding_polygon.csv'


#------------------------------------------------------------------------------
# Output Elevation Data
#------------------------------------------------------------------------------
# Output filename for elevation
# this is a combination of all the data (utilisied in build_boundary)
combined_name ='busselton_combined_elevation'
combined_smaller_name = 'busselton_combined_elevation_smaller'

#------------------------------------------------------------------------------
# Directory Structure
#------------------------------------------------------------------------------
anuga_dir = home+state+sep+scenario+sep+'anuga'+sep
topographies_in_dir = home+state+sep+scenario+sep+'elevation_final'+sep+'points'+sep
topographies_dir = anuga_dir+'topographies'+sep
polygons_dir = anuga_dir+'polygons'+sep
tide_dir = anuga_dir+'tide_data'+sep
boundaries_dir = anuga_dir+'boundaries'+ sep 
output_dir = anuga_dir+'outputs'+sep
gauges_dir = anuga_dir+'gauges'+sep
meshes_dir = anuga_dir+'meshes'+sep

#------------------------------------------------------------------------------
# Location of input and output data
#------------------------------------------------------------------------------

ascii_grid_filenames = [onshore_name,   # Topo
                        offshore_name5] # Busselton Topo

point_filenames = [coast_name,     # Coastline
                   coast_name1,    # Beach survey
                   offshore_name,  # Bathymetry
                   offshore_name1, # Bathymetry Charts
                   offshore_name2, # Digitised Fairsheet
                   offshore_name3, # 250m
                   offshore_name4] # Bunbury DPI


# 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_busselton.py)
meshes_dir_name = meshes_dir + scenario_name+'.msh'

# 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_busselton.py)
landward_dir = boundaries_dir + landward

# 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
urs_boundary_name = os.path.join(boundaries_dir_event,
                                 scenario_name)


# Where the directory of the output filename sits
output_build_time_dir = output_dir+build_time+dir_comment+sep   #used for build_busselton.py
output_run_time_dir = output_dir+run_time+dir_comment+sep       #used for run_busselton.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
building_in_dir_name = gauges_dir + building + '.csv'    #used for run_building_inundation.py

#------------------------------------------------------------------------------
# Interior region definitions
#------------------------------------------------------------------------------

# Land, to set the initial stage/water to be offcoast only
poly_mainland = read_polygon(polygons_dir+'initial_condition.csv')

# Land, to set the initial stage/water to be offcoast only
poly_marina = read_polygon(polygons_dir+'initial_condition_marina.csv')

# Initial bounding polygon for data clipping 
poly_all = read_polygon(polygons_dir+'poly_all_extend.csv')
res_poly_all = 100000*res_factor

# Area of Interest 1 (Busselton)
poly_aoi1 = read_polygon(polygons_dir+'busselton_1km.csv')
res_aoi1 = 500*res_factor

# Area of Interest 2 (Bunbury)
poly_aoi2 = read_polygon(polygons_dir+'bunbury_1km.csv')
res_aoi2 = 500*res_factor

# Area of Significance 1 (Busselton)
poly_aos1 = read_polygon(polygons_dir+'busselton_2km.csv')
res_aos1 = 10000*res_factor

# Area of Significance 2 (Bunbury)
poly_aos2 = read_polygon(polygons_dir+'busselton_2km.csv')
res_aos2 = 10000*res_factor

# Refined areas
# Polygon designed to islands
poly_aos3 = read_polygon(polygons_dir+'island1.csv')
res_aos3 = 10000*res_factor
poly_aos4 = read_polygon(polygons_dir+'island2.csv')
res_aos4 = 10000*res_factor

# Shallow water 1
poly_sw1 = read_polygon(polygons_dir+'coast_5km_d20m.csv')
res_sw1 = 40000*res_factor

# Combined all regions, must check that all are included!
interior_regions = [[poly_aoi1,res_aoi1],[poly_aoi2,res_aoi2],
                    [poly_aos1,res_aos1],[poly_aos2,res_aos2],
                    [poly_aos3,res_aos3],[poly_aos4,res_aos4],
                    [poly_sw1,res_sw1]]

    
trigs_min = number_mesh_triangles(interior_regions, poly_all,
                                  res_poly_all)
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
#------------------------------------------------------------------------------

# ASCII export grid for Busselton
xminBusselton = 340000
xmaxBusselton = 352000
yminBusselton = 6271500
ymaxBusselton = 6280000

# ASCII export grid for Bunbury
xminBunbury = 369000
xmaxBunbury = 381000
yminBunbury = 6308000
ymaxBunbury = 6316500