Skip to main content

Calculate waterdepths for 3Di results.

Project description

threedidepth

Calculate waterdepths for 3Di results.

  • Interpolated or gridcell-constant waterlevels

  • Interfaces with threediresults via threedigrid

  • Progress indicator support

  • Low memory consumption

For the interpolated mode, the ‘lizard’-method is used. For a detailed description, read the docstring for the LizardLevelCalculator.

Installation

Make sure GDAL is available as (from osgeo import gdal)

$ pip install threedidepth

Usage

From the cli:

$ threedidepth gridadmin.h5 results_3di.nc dem.tif waterdepth.tif

Or python:

>>> threedidepth.calculate_waterdepth(...)

Development installation with docker-compose

For development, clone the repository and use a docker-compose setup:

$ docker-compose build --build-arg uid=`id -u` --build-arg gid=`id -g` lib
$ docker-compose up --no-start
$ docker-compose start
$ docker-compose exec lib bash

Create a virtualenv:

# note that Dockerfile prepends .venv/bin to $PATH
(docker)$ virtualenv .venv --system-site-packages

Install dependencies & package and run tests:

(docker)$ pip install -r requirements.txt
(docker)$ pip install -e .[test]
(docker)$ pytest

Update packages:

(docker)$ rm -rf .venv
(docker)$ virtualenv .venv --system-site-packages
(docker)$ pip install -e .
(docker)$ pip freeze | grep -v threedidepth > requirements.txt

Changelog of threedidepth

0.4 (2021-03-23)

  • Enabled multiple calculation steps.

  • Added netCDF output option.

0.3 (2021-02-10)

  • Reorder to match the lizard triangulation.

0.2 (2020-12-10)

  • Implemented lizard method and set it as default.

0.1.2 (2020-09-21)

  • Fix off-by-one-pixel nodgrid.

0.1.1 (2020-09-11)

  • Fix flipped nodgrid.

0.1 (2020-09-03)

  • First version.

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

threedidepth-0.4.tar.gz (17.8 kB view details)

Uploaded Source

Built Distribution

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

threedidepth-0.4-py2.py3-none-any.whl (14.1 kB view details)

Uploaded Python 2Python 3

File details

Details for the file threedidepth-0.4.tar.gz.

File metadata

  • Download URL: threedidepth-0.4.tar.gz
  • Upload date:
  • Size: 17.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.11.0 pkginfo/1.4.2 requests/2.24.0 setuptools/41.6.0 requests-toolbelt/0.8.0 tqdm/4.25.0 CPython/3.6.9

File hashes

Hashes for threedidepth-0.4.tar.gz
Algorithm Hash digest
SHA256 998e9985de1db493d2889a20da878772f27d5edc92366c5a0dba88a3dfde766b
MD5 08db071d378585f5d157ba7ea433b5e3
BLAKE2b-256 61c82890c8c7a7e52cd5348ce6d82acba6a47c5191eaa54583fe4a9a8d2b295f

See more details on using hashes here.

File details

Details for the file threedidepth-0.4-py2.py3-none-any.whl.

File metadata

  • Download URL: threedidepth-0.4-py2.py3-none-any.whl
  • Upload date:
  • Size: 14.1 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.11.0 pkginfo/1.4.2 requests/2.24.0 setuptools/41.6.0 requests-toolbelt/0.8.0 tqdm/4.25.0 CPython/3.6.9

File hashes

Hashes for threedidepth-0.4-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 35124a1d8e4b094d53c9f21a8207e02c77712f96e475c234fbf0e88802bc9658
MD5 3c7b08ea65f11a8a27988eba118c1b05
BLAKE2b-256 1ca5c2c8ee248d14768ce400e1a52fbfde52f0354c6fe0b8a9330c85d9574e32

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