Tsunami Inundation Models for the BATEMANS BAY region

Analysis Scripts

There are number of analysis scripts on this disk that you can use to extract information from the SWW files produced by a simulation run. These scripts are not meant to be the definitive answer on how to get information from SWW files, but are offered as an example of one way to do it.

This page describes the scripts and shows how to use them. Note that due to the ad-hoc nature of the scripts, you must modify these scripts before they can be used to extract information from any SWW files you generate.

export_results_max.py

The export_results_max.py script can be used to create an ASC file that contains the maximum of an ANUGA variable or expression for each point in a user-defined ArcGIS grid on the simulation region.

You must change certain values within the export_results_max.py file to get what you want:

List the output folder names here, with one for each simulation you have run:
```
    time_dir1 = '20090505_150430_run_final_0.8_58292_None_kvanputt'
    time_dir2 = '20090505_150517_run_final_0_58292_None_kvanputt'
```
For information on output_folder_name.
Then modify the line:
```
    time_dirs = [time_dir1, time_dir2]
```
to include each of the variables you defined above.
Your SWW output will have a name like batemans_bay.sww. For a large model you may have more than one output file with extra filenames like batemans_bay_37860_0.sww, where the 37860 tells us that the timestep at the start of this file is 37860 sec. The export_results_max.py script needs to examine all SWW output files, so we specify all the files produced by the model run to create a maximum over the entire time. We do this by specifying the start times of all the extra SWW files:
```
    times = [37860]  or 
    times = [20000, 40000, 60000]
```
Note we do not have to specify the first SWW file, only the extra file start times. If there are no extra SWW files, just do:
```
    times = []
```
Modify the cellsize value to set the size of the ArcGIS grid you require. For example:
```
    cellsize = 20		# ArcGIS grid cell size in metres
```
Note: That this value should not go beyond the most refined part of the mesh i.e. if mesh resolution is 500m², cellsize = (500 x 2)^1/2 = 32m
You can get the maximum of a variable or expression over the entire model time, or for a single time in the simulation. Set timestep to the required time you want the maximum for, or set it to None to indicate that you want the maximum values over all timesteps:
```
    timestep = None  # over all timesteps
    #timestep = 0
```
Note that if you want the elevation use timestep = 0. Elevation does not change over time and you only need the first SWW file.
If you want to clip the ArcGIS grid to one or more small regions then put the names of the regions of interest into the area list:
```
    area = ['Batemans_Bay', 'NW', 'South']
```
Note that the name strings you put into the area list must match the names used in the project.py file. That is, if you use a name such as 'NW', then the project.py file must have lines like:
```
    xminNW = 548000
    xmaxNW = 561000
    yminNW = 5250000
    ymaxNW = 5258000
```
which set the maximum and minimum eastings and northings that define a rectangular region.
If you don't want to clip to a region of interest, then do this:
```
    area = ['All']		# no region of interest
```
Finally you must decide which variable or expression values you want sampled on your ArcGIS grid. Define a list var that contains strings defining the required variable or expression:
```
    var = ['depth', 'speed']
```
Note that the strings you supply must be defined in the var_equations dictionary prior to your definition of var:
```
    var_equations = {'stage':     'stage',
                     'momentum':  '(xmomentum**2 + ymomentum**2)**0.5',
                     'depth':     'stage-elevation',
                     'speed':     '(xmomentum**2 + ymomentum**2)**0.5/(stage-elevation+1.e-6)',
                     'elevation': 'elevation' }
```
This dictionary maps your var strings to a variable or expression.

get_timeseries.py

The get_timeseries.py script is used to get timeseries data for a selection of variable data at one or more timeseries gauge points in a simulation.

You must change certain values within the get_timeseries.py file to get what you want:

Depending on how many simulations you have run will determine the number of output folder names you insert here:
```
    time_dir1 = '20090505_150430_run_final_0.8_58292_None_kvanputt'
    time_dir2 = '20090505_150517_run_final_0_58292_None_kvanputt'
```
as necessary. Then modify the line:
```
    time_dirs = [time_dir1, time_dir2]
```
to include each of the variables you defined above.
Make sure that the gauges list specified in projects.py contains one or more CSV files defining the gauges within the simulation that you want the timeseries data for. The gauge file must have this format:
```
    easting,northing,name,elevation
    559134.8963,5251176.875,Connelly,2
    532441.5164,5239639.686,Opossum,2
```