source: anuga_work/production/australia_ph2/ceduna/project.py @ 6293

"""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.path import join
from os import sep, getenv
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')
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'

# this section needs to be updated to reflect the modelled community.
# Note, the user needs to set up the directory system accordingly
state = 'australia_ph2'
scenario_name = 'ceduna'

#------------------------------------------------------------------------------
# Initial Conditions
#------------------------------------------------------------------------------
# Model specific parameters. One or all can be changed each time the
# run_scenario script is executed
tide = 0 
event_number = 27255 # Java 9.3 worst case for Perth
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'
    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


#------------------------------------------------------------------------------
# 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))

#------------------------------------------------------------------------------
# Input Data
#------------------------------------------------------------------------------
# ELEVATION DATA
# Used in build_elevation.py
# Format for ascii grids, as produced in ArcGIS + a projection file
ascii_grid_filenames = ['grid250m'] # 250m grid 2005

# 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

# BOUNDING POLYGON - for data clipping and estimate of triangles in mesh
# Used in build_elevation.py
# Format for points easting,northing (no header)
bounding_polygon_filename = 'bounding_polygon.csv'

# GAUGES - for creating timeseries at a specific point
# Used in get_timeseries.py
# Format easting,northing,name,elevation (with header)
##gauges_filename = 'gauges.csv'

# 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!
# Check the run_model.py for boundary_tags

# Thinned ordering file from Hazard Map (geographic)
# Format is index,latitude,longitude (with header)
urs_order_filename = 'urs_order.csv'

# Landward bounding points
# Format easting,northing (no header)
landward_boundary_filename = 'landward_boundary.csv'

#------------------------------------------------------------------------------
# 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
#------------------------------------------------------------------------------
anuga_folder = join(home, state, scenario_name, 'anuga')
topographies_folder = join(anuga_folder, 'topographies')
polygons_folder = join(anuga_folder, 'polygons')
boundaries_folder = join(anuga_folder, 'boundaries')
output_folder = join(anuga_folder, 'outputs')
gauges_folder = join(anuga_folder,'gauges')
meshes_folder = join(anuga_folder, 'meshes')

#------------------------------------------------------------------------------
# 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
meshes = join(meshes_folder, scenario_name) + '.msh'

# The absolute pathname for the urs order points, used within build_boundary.py
urs_order = join(boundaries_folder, urs_order_filename)

# The absolute pathname for the landward points of the bounding polygon,
# Used within run_model.py)
landward_boundary = join(boundaries_folder, landward_boundary_filename)

# The absolute pathname for the .sts file, generated in build_boundary.py
event_sts = join(boundaries_folder, str(event_number), scenario_name)

# The absolute pathname for the output folder names
# Used for build_elevation.py
output_build = join(output_folder, build_time) + '_' + str(user) 
# Used for run_model.py
output_run = join(output_folder, run_time) + output_comment 
# Used by post processing
output_run_time = join(output_run, scenario_name) 

# The absolute pathname for the gauges file
# Used for get_timeseries.py
##gauges = join(gauges_folder, gauges_filename)       

#------------------------------------------------------------------------------
# Reading polygons and creating interior regions
#------------------------------------------------------------------------------

# Initial bounding polygon for data clipping 
bounding_polygon = read_polygon(join(polygons_folder,
                                     bounding_polygon_filename))
bounding_maxarea = 100000*scale_factor

interior_regions = []

# Estimate the number of triangles                     
trigs_min = number_mesh_triangles(interior_regions,
                                  bounding_polygon, bounding_maxarea)
print 'min estimated number of triangles', trigs_min