dfm-tools 0.11.0

dfm_tools are pre- and post-processing tools for Delft3D FM

dfm_tools

A Python package for pre- and postprocessing D-FlowFM model input and output files. Contains convenience functions built on top of other packages like xarray, xugrid, hydrolib-core and many more.

Information and examples

• pdf with dfm_tools information, features and examples
• online documentation generated from docstrings
• jupyter notebooks with example code
• use binder to run these notebooks interactively (loading takes a while)
• github folder with more example scripts

Installation basics

• latest release: pip install dfm_tools (excludes cartopy since it is only installable via conda)

Installation recommendation

• download and install Anaconda 64 bit (with Python 3.8 or later) from https://www.anaconda.com/distribution/#download-section
• open Anaconda prompt
• conda create --name dfm_tools_env -c conda-forge python=3.8 spyder -y (you can also install a newer python version)
• conda activate dfm_tools_env
• conda install -c conda-forge git shapely cartopy pyepsg geopandas contextily xarray dask netcdf4 bottleneck xugrid cdsapi pydap -y (installs conda-forge requirements)
• python -m pip install git+https://github.com/Deltares/dfm_tools (this command installs dfm_tools and all required non-conda packages, also use to update)
• long paths error? Check this Github issue
• OpenSSL error? Fix your conda base env by doing this or maybe this. Let us know if you encounter this issue.
• to remove environment when necessary: conda remove -n dfm_tools_env --all