randlab / hytool

Hytool is a matlab toolbox for the interpretation of hydraulic tests in wells. The toolbox contains analytical solutions used to describe groundwater flow around wells, and functions for importing, displaying, and fitting a model to the data.

hytool

Hytool is a matlab toolbox for the interpretation of hydraulic tests in wells. The toolbox contains analytical solutions used to describe groundwater flow around wells, and functions for importing, displaying, and fitting a model to the data.

The Wiki page of this repository explains how to install hytool on your machine.

To learn how to use hytool, a series of detailed examples and manuals are provided within the Matlab help.

To cite this toolbox, please use the following reference: Renard, Philippe (2017). Hytool: an open source matlab toolbox for the interpretation of hydraulic tests using analytical solutions. Journal of Open Source Software, 2(19), 441, doi:10.21105/joss.00441

R version

A rather complete version of Hytool in R is available. It is developped by François Bertone : https://github.com/FrancoisBertone/rhytool as an R package.

Python version

Some of the functionalities of hytool are also available in the hypy https://github.com/UniNE-CHYN/hypy Python module.

hytool's Issues

[JOSS review] Conflicting licenses

The repository contains a MIT license at the top level (https://github.com/pboesu/hytool/blob/master/LICENSE), but a GNU GPL v3 in the package documentation (https://github.com/pboesu/hytool/blob/master/html/license.txt) . Please harmonize the license terms.

[JOSS review] lack of unit tests

There are no automated tests as far as I can see, and as far as I can see no use is made of MATLAB's testing framework.

I am not familiar enough with MATLAB toolboxes or the MATLAB community to know whether or not this is standard practice.

[JOSS review] Lack of community guidelines

JOSS considers it good practice to provide communite guidelines for software users who want to

1. Contribute to the software
2. Report issues or problems with the software
3. Seek support

Please consider adding such guidelines to the documentation.