CERA contouring for KALPANA
Python
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
LICENSE_1_0.txt
README.md
cera_contour_matplotlib.py
example_1_plot.png
example_2_plot.png
example_3_plot.png
maxele.63.nc

README.md

Matplotlib Contouring for ADCIRC NetCDF Data

This script uses the python library matplotlib (http://matplotlib.org/) to create and plot contours from a single ADCIRC netcdf file. If multiple time steps are given in the ADCIRC netcdf file, the first time step will be extracted.

Copyright (C): Carola Kaiser 2014, Louisiana State University. With special thanks to Ian Thomas from the matplotlib developer team for helping us to create clean geometries.

This script is part of the Coastal Emergency Risks Assessment (CERA) software package, a real-time visualization system for ADCIRC storm surge guidance. See http://coastalemergency.org.

CERA is Open Source software; distributed under the Boost Software License, Version 1.0. (See accompanying file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)

Please visit also our STORM website (http://storm.stellar-group.org). The NSF funded STORM project focuses on introducing new and emerging technologies into the ADCIRC code base to create a sustainable software framework and infrastructure for at least the next 20 years.

Description

The Coastal Emergency Risks Assessment (CERA) team provides storm surge and wave guidance for the Northern Gulf and the Atlantic Coast through its online portal (http://coastalemergency.org). In addition to that, we are working towards the goal of providing all layers in the shapefile format compatible with GIS software. This feature will be available for the hurricane season 2015.

We use the Python Matplotlib library (http://matplotlib.org/) to convert the ADCIRC NetCDF format into contours which can then be used to generate shapefiles. While working on the algorithms, the CERA team has discovered some specifics which are essential to produce clean geometries. Clean geometries in GIS terminology do not include any self-intersections, overlapping, or duplicate features and ensure the hassle-free usability for GIS specialists and emergency managers.

Here are the specifics and bug fixes that we have addressed:

  1. Matplotlib 'tricontourf' expects a data array, but does not support masked arrays. If you pass a masked array, it will be ignored. The triangulation should only contain triangles with valid data at all three vertices. The solution is to either remove invalid triangles from your 'element' array before creating the triangulation, or set a mask on the triangulation once it has been created.

  2. The created contours will contain one or more polygon exteriors and zero or more interiors. They can be in any order (an exterior is not necessarily followed by its interiors). This has to be explicitly tested in your own script. The CERA code takes care of this issue.

System Requirements

Usage

cera_contour_matplotlib.py -i (input datafile) -a (netcdf attribute name) -g (mesh file) -n (intervals) -m (maxlevel)

mandatory:

  -i | infile       name of the NetCDF input file containing the ADCIRC data
  -a | attrname     attribute name of the NetCDF data array
  
  The option -g is only required if the ADCIRC mesh information is not included in the data 
  input file.
  -g | grid         name of the NetCDF file containing the ADCIRC mesh (default: input file)

optional:

  -n | intervals    number of contour intervals in output file (default:30)
  -m | maxlevel     maximum data value to be used for contouring (default:highest value 
                    in data array)

Example usage

Download the test data file (maxele.63.nc) in your script directory.

[1] cera_contour_matplotlib.py -i maxele.63.nc -a zeta_max Example 1

In this example, no optional parameters (-n intervals or -m maxlevel) are specified. The default values for these options will be applied. The maxlevel uses always the original units from the input file (here: meters). The output contours will be classified as 30 levels and stretched between zero and and the maximum data value in the input file (here: 10.62 meters).

[2] cera_contour_matplotlib.py -i maxele.63.nc -a zeta_max -m 2 Example 2

In this example, the maxlevel is given with the option -m as 2 (meters). The output contours will be classified as 30 levels (default value for the missing option -n (intervals). The levels will be limited to 0-2m.

[3] cera_contour_matplotlib.py -i maxele.63.nc -a zeta_max -n 10 -m 1 Example 3

In this example, the output contours will be classified as 10 levels (option -n intervals) between 0-1m (option -m maxlevel).

======================================= If you have any questions, please contact: Carola Kaiser, email: ckaiser@cct.lsu.edu

CERA: http://coastalemergency.org