hydromt-sfincs 0.2.1

hydroMT plugin for sfincs models.

hydroMT is a python package, developed by Deltares, to build and analysis hydro models. It provides a generic model api with attributes to access the model schematization, (dynamic) forcing data, results and states. This plugin provides an implementation for the SFINCS model.

Installation

hydroMT-sfincs is availble from pypi and we are working on adding a release from conda-forge (ongoing).

To install hydromt_sfincs using pip do:

pip install hydromt_sfincs

We recommend installing a hydromt-sfincs environment including the hydromt_sfincs package based on the environment.yml file. This environment will install all package dependencies including the core of hydroMT.

conda env create -f binder/environment.yml
conda activate hydromt-sfincs
pip install hydromt_sfincs

Documentation

Learn more about the hydroMT_sfincs plugin in its online documentation

Contributing

You can find information about contributing to hydroMT at our Contributing page.

License

Copyright (c) 2021, Deltares

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see <https://www.gnu.org/licenses/>.