Skip to main content

Generate a 3Di simulation grid from a model schematisation.

Project description

threedigrid-builder

Github Actions status PyPI

Generate a 3Di simulation grid from a model schematisation.

Usage

This library converts a model schematisation to a 3Di simulation grid. This can be done using a single function that reads data from an SQLite and TIFF and then outputs the generated grid into a Geopackage or HDF5 file:

>>> from threedigrid_builder import make_grid
>>> sqlite_path = "/path/to/model.sqlite"
>>> dem_path = "/path/to/dem.tiff"
>>> out_path = "grid.gpkg"  # or "something.h5" for HDF5 output
>>> make_grid(sqlite_path, dem_path, out_path)

Installation

This package is distributed as binary only, because its (Fortran) source code is proprietary. The currently supported platforms are Windows, Linux, and OSX, all 64 bit versions only.

First install sqlite and spatialite libraries, e.g. on Ubuntu:

$ sudo apt-get install sqlite3 libsqlite3-mod-spatialite

Then install the threedigrid-builder:

$ pip install threedigrid-builder[rasters]

For output into a file for the 3Di calculationcore, enable gridadmin output:

$ pip install threedigrid-builder[rasters,gridadmin]

For output into Geopackage for display in e.g. QGis, enable gpkg output:

$ pip install threedigrid-builder[rasters,gpkg]

Changelog of threedigrid-builder

0.4.0 (2021-09-23)

  • Added 1D boundary conditions.
  • Added 2D boundary conditions.
  • Enable compression in HDF5 output.
  • Fixed 2D lines that connect a larger to a smaller cell in south east direction.

0.3.1 (2021-08-16)

  • Handle embedded connection nodes. These are removed from the grid and written to a new dataset “nodes_embedded”.
  • Fixed bug with cross sections tables being None in Grid instance
  • Handle embedded channels, pipes and culverts. Embedded objects result in embedded nodes and and lines with kcu LINE_1D_EMBEDDED between between 2D cells.
  • Fixed a bug with lines that connect nodes to themselves in quadtree generation.
  • Fixed a bug with wrong usage of lines.ds1d in bottom level and cross section weights computation. The added attribute lines.s1d is now used, and for clarity nodes.ds1d was renamed to nodes.s1d.
  • Added invert_level_start_point and invert_level_end_point attributes to lines.
  • Fixed coordinate order in lines.line_geometries field in gridadmin.h5.

0.3.0 (2021-07-28)

  • Read and convert cross section definitions.
  • Solve gridadmin off-by-one errors for pumps.
  • Add ‘dmax’ to nodes output.
  • Changed external API function name to “make_gridadmin”.

0.2.1 (2021-07-20)

  • Fixed issue when reprojecting 0 grid refinements with pyproj 2.*
  • Fixed issue when writing 0 pumps with h5py 2.*
  • Fixed missing transpose when writing pumps.coordinates to HDF5.
  • Added obstacles.

0.2.0 (2021-07-15)

  • Added threedigrid_builder.grid.geo_utils with segmentize and line_substring functions. These are used to compute the Lines.line_geometries for channel lines.
  • Fixed a bug in the refinement areas code (Fortran) on Ubuntu 20.04.
  • Added the Pipes model that is able to compute Nodes & Lines from Pipes. Pipes are also included in the calculation_type and bottom_level computations.
  • Added 1D-2D lines for connection nodes, manholes, and channels.
  • Added culverts, orifices, and weirs.
  • Added pumps (pumpstations).
  • Settings and metadata are read from the SQLite. Some metadata (like model_slug) can also be provided via the main (make_grid) function. The metadata is written to the root ‘attrs’ of the output gridadmin.h5. The settings are written into datasets inside newly addres groups “grid_settings” and “tables_settings”.
  • Fixes for models with no channels.
  • Add an optional progress callback.

0.1.2 (2021-04-28)

  • Added public API with 1 function: threedigrid_builder.make_grid.

0.1.1 (2021-04-20)

  • Fixed automatic PyPI upload.

0.1.0 (2021-04-20)

  • Partially ported functionality from inpy (generate 3di files, makegrid): 1D channel grid (including calculation_type and bottom_level), and 2D open water grid.
  • Added gridadmin and geopackage output.
  • Breaking change: the interpolation between cross section locations (channels) now also extrapolates for lines and nodes that are not in between two connection nodes. This happens only if the channel has at least 2 cross section locations. When extrapolatic, the line.cross_weight is less than 0 or greater than 1.
  • Breaking change: missing or empty values in float datasets in the output gridadmin are now denoted by NaN (not-a-number) instead of -9999.0.
  • Breaking change: integers in the output gridadmin are now always 32-bit (instead of sometimes 32-bit and sometimes 64-bit).

Project details


Download files

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

Files for threedigrid-builder, version 0.4.0
Filename, size File type Python version Upload date Hashes
Filename, size threedigrid_builder-0.4.0-cp36-cp36m-macosx_10_9_x86_64.whl (1.6 MB) File type Wheel Python version cp36 Upload date Hashes View
Filename, size threedigrid_builder-0.4.0-cp36-cp36m-manylinux2010_x86_64.whl (1.9 MB) File type Wheel Python version cp36 Upload date Hashes View
Filename, size threedigrid_builder-0.4.0-cp36-cp36m-win_amd64.whl (869.0 kB) File type Wheel Python version cp36 Upload date Hashes View
Filename, size threedigrid_builder-0.4.0-cp37-cp37m-macosx_10_9_x86_64.whl (1.6 MB) File type Wheel Python version cp37 Upload date Hashes View
Filename, size threedigrid_builder-0.4.0-cp37-cp37m-manylinux2010_x86_64.whl (1.9 MB) File type Wheel Python version cp37 Upload date Hashes View
Filename, size threedigrid_builder-0.4.0-cp37-cp37m-win_amd64.whl (869.0 kB) File type Wheel Python version cp37 Upload date Hashes View
Filename, size threedigrid_builder-0.4.0-cp38-cp38-macosx_10_9_x86_64.whl (1.6 MB) File type Wheel Python version cp38 Upload date Hashes View
Filename, size threedigrid_builder-0.4.0-cp38-cp38-manylinux2010_x86_64.whl (2.0 MB) File type Wheel Python version cp38 Upload date Hashes View
Filename, size threedigrid_builder-0.4.0-cp38-cp38-win_amd64.whl (870.6 kB) File type Wheel Python version cp38 Upload date Hashes View
Filename, size threedigrid_builder-0.4.0-cp39-cp39-macosx_10_9_x86_64.whl (1.6 MB) File type Wheel Python version cp39 Upload date Hashes View
Filename, size threedigrid_builder-0.4.0-cp39-cp39-manylinux2010_x86_64.whl (2.0 MB) File type Wheel Python version cp39 Upload date Hashes View
Filename, size threedigrid_builder-0.4.0-cp39-cp39-win_amd64.whl (851.9 kB) File type Wheel Python version cp39 Upload date Hashes View

Supported by

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