Metadata-Version: 2.1
Name: threedidepth
Version: 0.5
Summary: Calculate waterdepths for 3Di results.
Home-page: https://github.com/nens/threedidepth
Author: Arjan Verkerk
Author-email: arjan.verkerk@nelen-schuurmans.nl
License: BSD license
Description: threedidepth
        ============
        
        Calculate waterdepths for 3Di results. For results of type 'raw' the variable
        's1' is used as waterlevel. For results of type 'aggregate', the variable
        's1_max' is used as waterlevel.
        
        * 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.5 (2021-07-02)
        ----------------
        
        - Added support for result type 'aggregate'.
        
        - Got rid of NetCDF4 dependency by using h5netcdf.
        
        - Fix coordinates of NetCDF output. (#17)
        
        
        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.
        
Keywords: threedidepth
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Topic :: Scientific/Engineering
Requires-Python: >=3.5
Provides-Extra: test
