Skip to main content

"Intuitive and powerful unstructured geospatial mesh generation from GIS data."

Project description

logo

build Code style: black Binder

dockerhub
readthedocs
jupyter

About TINerator

TINerator is a Python module for the easy creation of unstructured 3D and 2.5D meshes from GIS data sources. Digital Elevation Maps (DEMs) can be quickly turned into unstructured triangulated meshes, and then further refined by the import of flowline shapefiles or automatically through watershed delineation. Advanced layering and attribute functions then allow for a complex subsurface to be defined.

TINerator comes with a host of 2D and 3D visualization functions, allowing the user to view the status of the mesh at every step in the workflow. In addition, there are geometrical tools for removing triangles outside of a polygon, generating quality analytics on the mesh, adding cell- and node-based attributes to a mesh, and much more.

It was created at Los Alamos National Laboratory and funded primarily through the IDEAS-Watersheds and NGEE Arctic programs. It has since been used by researchers and US-DOE national laboratories nation-wide.

TINerator has been designed to work well with Amanzi-ATS.

Documentation

Quick Start

Online Demo

Binder

You can run TINerator Jupyter notebooks online with MyBinder. It may take a few minutes for the container to initialize.

Docker Container

The easiest way to get started with TINerator is through Docker:

$ docker pull ees16/tinerator:latest
$ docker run -it \
    -v $(pwd):/docker_user/work \
    -p 8899:8899 \
    -p 8050:8050 \
    ees16/tinerator:latest

After the container launches, navigate to http://127.0.0.1:8899/lab in a web browser to begin using TINerator within a Jupyter Lab instance. Example notebooks and HTML documentation are available within Jupyter.

Building TINerator

To build TINerator from source, refer to the documentation.

Linux

$ apt-get install --no-install-recommends -y \
  g++ \
  gfortran \
  make \
  cmake \
  libgl1-mesa-glx \
  \
  # NOTE: gdal on conda forge is *strongly* preferred
  # to the apt version.
  libdal-dev

macOS

$ brew install \
    gdal \
    gcc \
    gfortran

Note that the module has not been tested on Apple Silicon yet.

Contributing

Pull requests of all manner are welcomed! Please read the contributing guidelines before submitting a pull request.

Download files

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

Source Distribution

tinerator-0.9.1.tar.gz (25.0 MB view hashes)

Uploaded source

Built Distribution

tinerator-0.9.1-py2.py3-none-any.whl (21.3 MB view hashes)

Uploaded py2 py3

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page