Skip to main content
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_gridadmin
>>> sqlite_path = "/path/to/model.sqlite"
>>> dem_path = "/path/to/dem.tiff"
>>> out_path = "grid.gpkg"  # or "something.h5" for HDF5 output
>>> make_gridadmin(sqlite_path, dem_path, out_path)

Alternatively, the generated grid can be output in-memory:

>>> make_gridadmin(sqlite_path, dem_path)
{'nodes': {'id': array([   1,    2,    3, ..., 7903, 7904, 7905], dtype=int32), ...}

Installation

This package is distributed as source and binary wheels on PyPI. 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

For raster input, GDAL is required to be present. We omitted these from the dependencies because installation of GDAL depends on your platform an on your personal perference. One option is to install gdal using apt-get, and then pygdal with a matching version:

$ sudo apt-get libgdal-dev $ pip install pygdal=={your gdal version}.*

Install the threedigrid-builder:

$ pip install threedigrid-builder

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

$ pip install threedigrid-builder[gridadmin]

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

$ pip install threedigrid-builder[gpkg]

The command line interface requires Typer:

$ pip install threedigrid-builder[cli]

Metadata

Release files for threedigrid-builder 1.14.4

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for threedigrid-builder 1.14.4
File Size Uploaded
threedigrid_builder-1.14.4.tar.gz 151.5 kB Details

Built distributions (wheels)

Table of built distributions (wheels) for threedigrid-builder 1.14.4
File
threedigrid_builder-1.14.4-cp312-cp312-win_amd64.whl CPython 3.12 CPython 3.12 Windows x86-64 Details
threedigrid_builder-1.14.4-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl CPython 3.12 CPython 3.12 Linux glibc 2.17+ x86-64 Details
threedigrid_builder-1.14.4-cp312-cp312-macosx_10_9_x86_64.whl CPython 3.12 CPython 3.12 macOS 10.9+ x86-64 Details
threedigrid_builder-1.14.4-cp311-cp311-win_amd64.whl CPython 3.11 CPython 3.11 Windows x86-64 Details
threedigrid_builder-1.14.4-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl CPython 3.11 CPython 3.11 Linux glibc 2.17+ x86-64 Details
threedigrid_builder-1.14.4-cp311-cp311-macosx_10_9_x86_64.whl CPython 3.11 CPython 3.11 macOS 10.9+ x86-64 Details
threedigrid_builder-1.14.4-cp310-cp310-win_amd64.whl CPython 3.10 CPython 3.10 Windows x86-64 Details
threedigrid_builder-1.14.4-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl CPython 3.10 CPython 3.10 Linux glibc 2.17+ x86-64 Details
threedigrid_builder-1.14.4-cp310-cp310-macosx_10_9_x86_64.whl CPython 3.10 CPython 3.10 macOS 10.9+ x86-64 Details
threedigrid_builder-1.14.4-cp39-cp39-win_amd64.whl CPython 3.9 CPython 3.9 Windows x86-64 Details
threedigrid_builder-1.14.4-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl CPython 3.9 CPython 3.9 Linux glibc 2.17+ x86-64 Details
threedigrid_builder-1.14.4-cp39-cp39-macosx_10_9_x86_64.whl CPython 3.9 CPython 3.9 macOS 10.9+ x86-64 Details
threedigrid_builder-1.14.4-cp38-cp38-win_amd64.whl CPython 3.8 CPython 3.8 Windows x86-64 Details
threedigrid_builder-1.14.4-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl CPython 3.8 CPython 3.8 Linux glibc 2.17+ x86-64 Details
threedigrid_builder-1.14.4-cp38-cp38-macosx_10_9_x86_64.whl CPython 3.8 CPython 3.8 macOS 10.9+ x86-64 Details

Total release size: 17.6 MB

Release files / threedigrid_builder-1.14.4.tar.gz

Download URL threedigrid_builder-1.14.4.tar.gz
Size 151.5 kB
Tags Source
SHA-256 checksum
How to use checksums
d14500e40842642d6ef106d0a297f024d094c384f7ab40aa9c2aec1261892d8b
BLAKE2b-256 checksum
How to use checksums
047fad743850a0ec01e18c7b4b22bd681bdb8f34aa8212e5d59b52981b987b66
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/5.1.0 CPython/3.12.4

Release files / threedigrid_builder-1.14.4-cp312-cp312-win_amd64.whl

Download URL threedigrid_builder-1.14.4-cp312-cp312-win_amd64.whl
Size 618.3 kB
Tags CPython 3.12 Windows x86-64
SHA-256 checksum
How to use checksums
10a96e26b848044f2c94f53264b248849bdb027b6e03eeee4e167386ae279879
BLAKE2b-256 checksum
How to use checksums
6cd8e3d88ad1c2e46562585565f241dba53c089d9d7ab45aa20f51d14a01ee09
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/5.1.0 CPython/3.12.4

Release files / threedigrid_builder-1.14.4-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl

Download URL threedigrid_builder-1.14.4-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Size 1.3 MB
Tags CPython 3.12 Linux glibc 2.17+ x86-64
SHA-256 checksum
How to use checksums
55055c79abf3d4cf53852dbce36cc32b92214bf60cf5e45a107b6326e38146c0
BLAKE2b-256 checksum
How to use checksums
da866603905deeed966584c7b8d1367c03034d4bc347e45dad9989f8a0576112
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/5.1.0 CPython/3.12.4

Release files / threedigrid_builder-1.14.4-cp312-cp312-macosx_10_9_x86_64.whl

Download URL threedigrid_builder-1.14.4-cp312-cp312-macosx_10_9_x86_64.whl
Size 1.6 MB
Tags CPython 3.12 macOS 10.9+ x86-64
SHA-256 checksum
How to use checksums
8f0e4a541e71073eb060a66bd50d532ffe6c6738f5592fa31d41213858cc2ea0
BLAKE2b-256 checksum
How to use checksums
8f7482f761a39335ba6497cd049691b2880c6cfb1003155e57d1ad1d3ca3f618
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/5.1.0 CPython/3.12.4

Release files / threedigrid_builder-1.14.4-cp311-cp311-win_amd64.whl

Download URL threedigrid_builder-1.14.4-cp311-cp311-win_amd64.whl
Size 618.3 kB
Tags CPython 3.11 Windows x86-64
SHA-256 checksum
How to use checksums
d6e5722aba35fdb3187687dc69a33ae58dab158a72fd9436214e740cc6749070
BLAKE2b-256 checksum
How to use checksums
cfb59cfcbf4b6fd29ea0c375a066079fcc41ce68b3b32dff21e20f63fd616815
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/5.1.0 CPython/3.12.4

Release files / threedigrid_builder-1.14.4-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl

Download URL threedigrid_builder-1.14.4-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Size 1.3 MB
Tags CPython 3.11 Linux glibc 2.17+ x86-64
SHA-256 checksum
How to use checksums
aa3c967d544cc76972a26620cf23be01336d04dad354cdc9b1d153cbe9cf2bda
BLAKE2b-256 checksum
How to use checksums
038b86949535394f934a78c8abc09ff1968c0b44bbb06547e81022e4d894e8c8
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/5.1.0 CPython/3.12.4

Release files / threedigrid_builder-1.14.4-cp311-cp311-macosx_10_9_x86_64.whl

Download URL threedigrid_builder-1.14.4-cp311-cp311-macosx_10_9_x86_64.whl
Size 1.6 MB
Tags CPython 3.11 macOS 10.9+ x86-64
SHA-256 checksum
How to use checksums
22547ec8252e12070e396f10f720ae17a338fa00564667141870a9e46932c27b
BLAKE2b-256 checksum
How to use checksums
1d1dc14bd9cca4bfb09fcafe4f2483064ca4b224a352a6265c6314f82808cd3b
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/5.1.0 CPython/3.12.4

Release files / threedigrid_builder-1.14.4-cp310-cp310-win_amd64.whl

Download URL threedigrid_builder-1.14.4-cp310-cp310-win_amd64.whl
Size 619.3 kB
Tags CPython 3.10 Windows x86-64
SHA-256 checksum
How to use checksums
4243094fd0e36ce3a3fd06c85dc6ddf820aa13815b1668e34342ce49d1aaf4e8
BLAKE2b-256 checksum
How to use checksums
d5d176e49585e38caf346f8e7d437660db2d8b4e8a953e7c6bd60ba333803686
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/5.1.0 CPython/3.12.4

Release files / threedigrid_builder-1.14.4-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl

Download URL threedigrid_builder-1.14.4-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Size 1.3 MB
Tags CPython 3.10 Linux glibc 2.17+ x86-64
SHA-256 checksum
How to use checksums
9be61c466df799e775944b81ff6673b00e545f7b4a9df9de15c1473a9614efa9
BLAKE2b-256 checksum
How to use checksums
bd8cdb51b687ee80cf28787f7b862b62e77e096001513176252d824384d2739c
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/5.1.0 CPython/3.12.4

Release files / threedigrid_builder-1.14.4-cp310-cp310-macosx_10_9_x86_64.whl

Download URL threedigrid_builder-1.14.4-cp310-cp310-macosx_10_9_x86_64.whl
Size 1.6 MB
Tags CPython 3.10 macOS 10.9+ x86-64
SHA-256 checksum
How to use checksums
ec5d88dc249c8f866baa43223c936bc31025decfa03b0d2b76b6aaa1ee8079d7
BLAKE2b-256 checksum
How to use checksums
07ff2b67e895ade6584a8dc2610185caa019252535032f4633400198d8bb87bd
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/5.1.0 CPython/3.12.4

Release files / threedigrid_builder-1.14.4-cp39-cp39-win_amd64.whl

Download URL threedigrid_builder-1.14.4-cp39-cp39-win_amd64.whl
Size 619.6 kB
Tags CPython 3.9 Windows x86-64
SHA-256 checksum
How to use checksums
c87e3703e84844381184828da6a9fe5f24f2d79e55c030b5b81d122c7887cec8
BLAKE2b-256 checksum
How to use checksums
75b77849ad6f25e17f72f4c7e411b36b456205db2c501ad495bfc97c1cd3b813
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/5.1.0 CPython/3.12.4

Release files / threedigrid_builder-1.14.4-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl

Download URL threedigrid_builder-1.14.4-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Size 1.3 MB
Tags CPython 3.9 Linux glibc 2.17+ x86-64
SHA-256 checksum
How to use checksums
bee7cb9079e8e381ccdde27782415e863c79d31e2d4fcde00dc76e3caf87ace9
BLAKE2b-256 checksum
How to use checksums
be4d433aee868c4a1bcdc44093af52b36e77157cad58dfc44577b13256057190
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/5.1.0 CPython/3.12.4

Release files / threedigrid_builder-1.14.4-cp39-cp39-macosx_10_9_x86_64.whl

Download URL threedigrid_builder-1.14.4-cp39-cp39-macosx_10_9_x86_64.whl
Size 1.6 MB
Tags CPython 3.9 macOS 10.9+ x86-64
SHA-256 checksum
How to use checksums
4708847e3e2e79f00ae9e3df64845b73e1966d2f8f4791165d0d7f80bc42ece6
BLAKE2b-256 checksum
How to use checksums
f7592d0188f2cd758a4f4d22edd63c74a4363f6f23e49ac2a29b1ffb00afa92e
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/5.1.0 CPython/3.12.4

Release files / threedigrid_builder-1.14.4-cp38-cp38-win_amd64.whl

Download URL threedigrid_builder-1.14.4-cp38-cp38-win_amd64.whl
Size 616.8 kB
Tags CPython 3.8 Windows x86-64
SHA-256 checksum
How to use checksums
224c0f06463e988d9de20df859046574c4d3a7529b07d978d1ff1b2b52ed7466
BLAKE2b-256 checksum
How to use checksums
aa23f0c7b6a51d462a0f28bbdf801b465d3526012c7b19d18edec4c2b3880d82
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/5.1.0 CPython/3.12.4

Release files / threedigrid_builder-1.14.4-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl

Download URL threedigrid_builder-1.14.4-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Size 1.3 MB
Tags CPython 3.8 Linux glibc 2.17+ x86-64
SHA-256 checksum
How to use checksums
9b6edc6fe2829e06f5755ca5296b369febd9f232886765cb34737861df120dab
BLAKE2b-256 checksum
How to use checksums
0b228868b2266baa2f8f9747100232807de4151fd720322ee5d5d724d6415d63
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/5.1.0 CPython/3.12.4

Release files / threedigrid_builder-1.14.4-cp38-cp38-macosx_10_9_x86_64.whl

Download URL threedigrid_builder-1.14.4-cp38-cp38-macosx_10_9_x86_64.whl
Size 1.6 MB
Tags CPython 3.8 macOS 10.9+ x86-64
SHA-256 checksum
How to use checksums
f8aea51f98ed91e103b760da5b36f66a0fc7da7bdd67d0a60f2b9184df2e5bc7
BLAKE2b-256 checksum
How to use checksums
6265907d17b7ef7c16a28c046cff38aa8d37d256a2c3b80813cc2e9c3b7f6e94
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/5.1.0 CPython/3.12.4

Release history Release notifications | RSS feed

This release

1.14.4 This release

16 release files

1.8.0

13 release files

1.7.1

13 release files

1.7.0

13 release files

1.5.0

13 release files

1.4.0

13 release files

1.3.5

12 release files

1.3.4

12 release files

1.3.3

12 release files

1.2.1

12 release files

1.2.0

12 release files

1.1.0

12 release files

1.0.2

12 release files

1.0.1

12 release files

1.0.0

12 release files

0.9.2

12 release files

0.9.1

12 release files

0.9.0

12 release files

0.8.0

12 release files

0.7.0

12 release files

0.6.1

12 release files

0.5.0

12 release files

0.4.0

12 release files

0.3.1

8 release files

0.3.0

8 release files

0.2.1

8 release files

0.2.0

8 release files

0.1.2

8 release files

0.1.1

8 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page