Skip to main content

Generation of boundary representation and mesh spatial discretisations from arbitrary geophysical fields.

Project description

Shingle

Build Status Python2 PyPI DOI

Generalised self-consistent and automated domain discretisation for multi-scale geophysical models.

Shingle

Shingle is a generalised and accessible framework for model-independent and self-consistent geophysical domain discretisation, which accurately conform to fractal-like bounds and at varyingly resolved spatial scales. The full heterogeneous set of constraints are necessarily completely described by an extensible, hierarchical formal grammar with an intuitive natural language basis for geophysical domain features to achieve robust reproduction and consistent model intercomparisons.

LibShingle: Computational research software library providing a high-level abstraction to spatial discretisation, or mesh generation, for domains containing complex, fractal-like boundaries that characterise those in numerical simulations of geophysical dynamics. This is accompanied by a compact, shareable and necessarily complete description of the domain discretisation.

Geophysical model domains typically contain irregular, complex fractal-like boundaries and physical processes that act over a wide range of scales. Constructing geographically constrained boundary-conforming spatial discretisations of these domains with flexible use of anisotropic, fully unstructured meshes is a challenge. The problem contains a wide range of scales and a relatively large, heterogeneous constraint parameter space. Approaches are commonly ad hoc, model or application specific and insufficiently described. Development of new spatial domains is frequently time-consuming, hard to repeat, error prone and difficult to ensure consistent due to the significant human input required. As a consequence, it is difficult to reproduce simulations, ensure a provenance in model data handling and initialisation, and a challenge to conduct model intercomparisons rigorously. Moreover, for flexible unstructured meshes, there is additionally a greater potential for inconsistencies in model initialisation and forcing parameters. This library introduces a consistent approach to unstructured mesh generation for geophysical models, that is automated, quick-to-draft and repeat, and provides a rigorous and robust approach that is consistent to the source data throughout. The approach is enabling further new research in complex multi-scale domains, difficult or not possible to achieve with existing methods.

Outline web page: http://shingleproject.org

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

For further information and updates, please contact the lead author Dr Adam S. Candy at contact@shingleproject.org and see related research pages at http://candylab.org.

Example geophysical domains

A selection of geophysical domains where Shingle has been applied to describe and generate geophysical domain spatial discretisation.

Shingle examples

Objectives

  1. Introduce a consistent approach to the generation of boundary representation to arbitrary geoid bounds.
  2. A user-friendly, accessible and extensible framework for model-independent geophysical domain mesh generation.
  3. An intuitive, hierarchical formal grammar to fully describe and share the full heterogeneous set of constraints for the spatial discretisation of geophysical model domains.
  4. Natural language basis for describing geophysical domain features.
  5. Self-consistent, scalable, automated and efficient mesh prototyping.
  6. Platform for iterative development that is repeatable, reproducible with a provenance history of generation.
  7. Enabling rigorous unstructured mesh generation in general, for a wide range of geophysical applications, in a process that is automated, quick-to-draft and repeat, rigorous and robust, and consistent to the source data throughout.

Verification test engine

Includes a selection of examples, from a relatively straight-forward high-level GUI-driven interaction accessible to modellers new to mesh generation, to complex low-level development communicating with the LibShingle library. Python interaction is used within the source, in generating documentation and in example Jupyter notebooks.

A verification test engine is continuously run in response to source code changes, some of which is tested under http://travis-ci.org/shingleproject/Shingle.

An earlier version of the library Shingle 1.0 is available at: https://github.com/shingleproject/Shingle1.0, with details on the Shingle1.0 webpage.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

shingle-2.1.11.tar.gz (132.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

shingle-2.1.11-cp27-cp27m-macosx_10_13_x86_64.whl (210.9 kB view details)

Uploaded CPython 2.7mmacOS 10.13+ x86-64

File details

Details for the file shingle-2.1.11.tar.gz.

File metadata

  • Download URL: shingle-2.1.11.tar.gz
  • Upload date:
  • Size: 132.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for shingle-2.1.11.tar.gz
Algorithm Hash digest
SHA256 a045febb926b085a509e2d9776da62e629147bc8120affa57471eace8123d0de
MD5 abd17297624cd11ffa9a45f893fa002a
BLAKE2b-256 767ca9678ab9dd2ddedcd62d11b6f0d0c7b1a979ae352b23343de8512ad887a4

See more details on using hashes here.

File details

Details for the file shingle-2.1.11-cp27-cp27m-macosx_10_13_x86_64.whl.

File metadata

File hashes

Hashes for shingle-2.1.11-cp27-cp27m-macosx_10_13_x86_64.whl
Algorithm Hash digest
SHA256 45e6db4f8bb93d81e00bfa3ce16c0a6073a167067598085275c47fed04a4655d
MD5 25795d22d4f46bd2e71c4ab0b1541f3d
BLAKE2b-256 0325197e9004d3e149234845e9958542f93a43b8e6734a232249c4266c401716

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page