Skip to main content

Python implementation of the HYDRUS-1D model

Project description

Pydrus: Python implementation of the HYDRUS-1D

This package provides a Python implementation of the HYDRUS-1D unsaturated zone model developed by Šimůnek, J., M. Th. van Genuchten, and M. Šejna. More information on the HYDRUS-1D model is available here. This software is licenced under the GNU GENERAL PUBLIC LICENSE found here. The Pydrus code is developed by Raoul Collenteur, Giuseppe Brunetti and Matevz Vremec. With Pydrus, a HYDRUS-1D model can be created, calibrated and visualized through Python scripts, making it easy to adjust the model and providing a 100% reproducible workflow of your modeling process.

Examples and Documentation

Examples of using Pydrus can be found in the example folder. This folder also contains a number of Jupyter Notebooks that thoroughly explain the use of the software. Documentation is still under development.

Installing Pydrus

1. Installing the Python package

The Pydrus package will be available on the Pypi package index as the software moves towards production ready software. To install in developer mode, use the following syntax:

>>> pip install -e .

2. Compiling the source code

Before you can use Pydrus the adapted Fortran77 files need to be compiled to an executable. The makefile (MacOS/Linux) and the make.bat (Windows) in the source folder are available to create the hydrus executable. Move into the source folder (which you can download from this GitHub page) and use the following syntax in your terminal or windows command line to compile the source code:

>>> make

This should create a Windows or Linux Executable that can be used to run the HYDRUS-1D simulation. In the Python code, you have to reference to the location of the executable so you can store it anywhere you want.

Developing Pydrus

Pydrus is a community effort and help is always welcome. If you have found abug, please open a GitHub issue to report it. Pull requests including bug fixes and new functionality are very welcome and will be accepted on the Dev-branch of this repository.

Citing Pydrus

If you use pydrus for one of your projects, we ask that you cite the code as follows: Collenteur, R.A., Brunetti, G., and M. Vremec (2019) Pydrus: Python implementation of the HYDRUS-1D unsaturated zone model. Version X.X.X

Project details


Release history Release notifications

This version

0.0.1

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for pydrus, version 0.0.1
Filename, size File type Python version Upload date Hashes
Filename, size pydrus-0.0.1-py2.py3-none-any.whl (12.9 kB) File type Wheel Python version py2.py3 Upload date Hashes View hashes
Filename, size pydrus-0.0.1.tar.gz (11.8 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page