-
Notifications
You must be signed in to change notification settings - Fork 11
Community guidelines
We appreciate very much your interest in using and or contributing to hytool and hope that the toolbox will help you interpreting hydrogeological data.
hytool contains a rather large number of analytical solutions for the interpretation of hydraulic tests around wells. But there are still many solutions that are not available because of limited resources and time to code them. Extending the code to other kind of analytical solutions or to include tracer tests will be very much appreciated. Your participation is therefore very welcome.
Do not hesitate to contact me directly if you need more information !
The simplest to use hytool is to follow the installation procedure and to look at the basic example in the matlab documentation.
We have been working hard to make the code as robust and reliable as possible.
Most of the obvious bugs have been already found and corrected. But it's not impossible that you may encounter a problem. If you find one, please describe it as precisely as possible (if you can provide the data and matlab files, it helps) and post an issue.
If you are interested in contributing, here are a few ideas on what could be useful and what would be very much appreciated.
First, if you find a bug and can correct it directly, that will be wonderful and will help others for sure. So please don't hesistate in sharing your corrections.
Then, among the different ideas that could be developped around hytool, one would be to extend the current toolbox by adding new analytical solutions or new methods for interpretation. For example, the interpretation of pumping test data in unconfined aquifers could be improved by adding the Neuman (1972) solution or the more recent works of Moench and colleagues. Other more recent solutions are also obviously very welcome.
Another idea would be to translate the code in python or Julia to allow to use the tools on a completely open environment. Some preliminary attempts have been made in Python and in R (hytool in R), but they are still incomplete and some contributions from the community could be very valuable to all.
The preferred workflow for contributing to hytool is to fork the
hytool repository https://github.com/UniNE-CHYN/hytool on
GitHub, clone, and develop your modifications on a branch. Then submit a pull request.
If you are not familiar with Git, either check the Git documentation https://git-scm.com/documentation online or contact me directly by email.
To add an analytical solution to hytool please respect the Syntax convention of the already existing analytical solutions. These conventions are explained in the documentation of the toolbox available within matlab. Following the syntax convention will help keeping hytool consistent and will facilitate the use of the toolbox.
In brief, every new solution should:
- use a three letters code for its name,
- include the basic functions allowing to compute the solution in dimensionless form, draw it, produce a report, etc.
- include a data set
- include an example (dmo) where the data set is interpreted and allowing to show and check how the solution performs
- all functions must be documented following the usual matlab standards