Skip to content

Latest commit

 

History

History
44 lines (36 loc) · 2.45 KB

README.md

File metadata and controls

44 lines (36 loc) · 2.45 KB

Wflow

Build Status Coverage Dev Stable DOI ColPrac: Contributor's Guide on Collaborative Practices for Community Packages

Wflow is a Julia package that provides a hydrological modeling framework, as well as several different vertical and lateral concepts that can be used to run hydrological simulations. It is a continuation of the work available here.

Documentation

See stable or dev for the documentation.

Installation

For the installation enter the Pkg REPL by pressing ] from the Julia REPL, and then

pkg> add Wflow

A more detailed description, including a development install, is available here.

Contributions and reporting issues

We welcome reporting of issues here. Please provide a minimum working example so we are able to reproduce the issue. Furthermore, we welcome contributions. We follow the ColPrac guide for collaborative practices. New contributors should make sure to read that guide.

Citing

For publications, please cite the following paper introducing Wflow.jl and describing the wflow_sbm concept, together with some case studies:

van Verseveld, W. J., Weerts, A. H., Visser, M., Buitink, J., Imhoff, R. O., Boisgontier, H., Bouaziz, L., Eilander, D., Hegnauer, M., ten Velden, C., and Russell, B., 2024. Wflow_sbm v0.7.3, a spatially distributed hydrological model: from global data to local applications. Geosci. Model Dev., 17, 3199–3234. https://doi.org/10.5194/gmd-17-3199-2024.

To cite a specific software version of wflow please use the DOI provided in the Zenodo badge above, that points to the latest release.