Generation of boundary representation from arbitrary geophysical fields.
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.
data
tests
.travis.yml
AUTHORS
LICENSE
Makefile
README.md
setup.py
shingle.py

README.md

Shingle

Generation of boundary representation from arbitrary geophysical fields.

For further information and updates, please contact the author Dr Adam S. Candy at contact@shingleproject.org.

Shingle

Outline web page: http://shingleproject.org

Further details are provided in the library source and Shingle project manual.

Build status

Build Status

Example geophysical domains

A selection of geophysical domains where Shingle has been applied to generate the boundary representation. This description is then meshed using Gmsh.

Shingle examples

Outline

A new meshing approach for realistic domains.

This code generates boundary representations with element identifications from arbitrary geophysical fields. It was originally used mask to generate a boundary along the coastlines and grounding line (which is not positioned at a constant depth). The code is easily applied to boundaries along depth contours and to work with other NetCDF sources.

The new approach uses contouring routines (as opposed to the GSHHS Gmsh plugin, or a GMT approach). It would be useful to test this new code on a wide range of regions - particularly to check the contouring routines are behaving satisfactorily. It works very well in the Antarctic region (including the region inside ice shelf cavities).

The dependencies are all Python modules (e.g. GMT is not required).

Supported features

  • Generate boundary representation from raw raster input (e.g. a NetCDF data file),
  • Regions defined by arbitrary functions of longitude and latitude (given on the command line),
  • Simpler definition of regions by boxes (such as 'longmin:longmax,latmin:longmax'),
  • Define included paths by Gmsh ID number (useful to include or exclude specific islands/land masses),
  • Deals with multiple open boundaries,
  • Islands and boundaries split by the global boundary are treated,
  • Automatically closes boundaries with parallels and meridians (with a prescribed length step),
  • Applies different boundary IDs on open and closed boundaries,
  • Exclude smaller islands - restricted by a given minimum area,
  • Option to extend domain in latitude on open boundaries (e.g. for sponge regions, or large open regions in the open ocean),
  • Command line used is saved in the Gmsh .geo file for reference,
  • Projection type (e.g. options to generate a mesh to UTM coordinates,
  • Option to generate the ACC average track line (and then to refine the mesh to this).
  • Ice shelf inclusion options

Development version

A development version of the code also has:

  • Caching of contours (which can save a lot of processing time)
  • Graphical output of contouring stage, to aid in contour selection

Other updates

  • Consistent use of dx_default,
  • The Antarctica main example contour can now be meshed (uses dx=10 in the parallel creation now),
  • Renamed the variables associated with the inclusion of the ice shelf ocean cavities to be more intuitive.

Test suite

Currently there are six tests in the test suite:

  • amundsen_sea
  • antarctica_all
  • antarctica_main_landmass
  • antarctica_main_landmass_30s
  • filchner-ronne
  • filchner-ronne_iceshelf

Datasets

The above tests use the RTopo dataset, described in detail at: http://doi.pangaea.de/10.1594/PANGAEA.741917.

Timmermann, R et al. (2010): Antarctic ice sheet topography, cavity geometry, and global bathymetry (RTopo 1.0.5-beta). doi:10.1594/PANGAEA.741917, Supplement to: Timmermann, Ralph; Le Brocq, Anne M; Deen, Tara J; Domack, Eugene W; Dutrieux, Pierre; Galton-Fenzi, Ben; Hellmer, Hartmut H; Humbert, Angelika; Jansen, Daniela; Jenkins, Adrian; Lambrecht, Astrid; Makinson, Keith; Niederjasper, Fred; Nitsche, Frank-Oliver; Nøst, Ole Anders; Smedsrud, Lars Henrik; Smith, Walter (2010): A consistent dataset of Antarctic ice sheet topography, cavity geometry, and global bathymetry. Earth System Science Data, 2(2), 261-273, doi:10.5194/essd-2-261-2010