watlab 0.6.1

The watlab package is a Python interface for the C++-based hydraulical simulation sandbox. It is intended mainly for scholars.

Watlab is Python-API dedicated to hydraulics simulations. The Python-API allows you to drive the different solvers available in the toolbox. The following prerequisites are mandatory to use Watlab:

1. A working version of Python
2. Some basic knowledge on Python scripting
3. A mesh made either with GMSH or with QGIS and exported as a shapefile (see also our website).

Get Watlab

Watlab is supported on Python 3.11 or later.

Watlab installation is slightly made harder by its (weak) dependency to the libgdal package. On Linux and MacOS, installation is included in the resterio installer. On Windows, one needs to install GDAL first.

If necessary, you can download the installers here:

• Download gdal 3.4.3 for Windows (for Win_AMD64; for another version, see here).

Install GDAL before you install watlab. On Windows hit :

python -m pip install GDAL-3.4.3-cp311-cp311-wind_amd64.whl
python -m pip install watlab

On Linux and Mac, hit:

sudo apt update
sudo apt install libglu1
sudo apt install libxcursor1
sudo apt install libxft2
sudo apt install libxinerama1
python -m pip install watlab

Run Watlab (for the impatients)

In order to test your Watlab instance, create a folder somewhere in your computer (say in ~/usr/myWatlab/) and unzip this archive.

Open the Conda prompt and activate your newly created watlab environment:

conda activate watlab

Then run the script with

python .\watlab-first-script.python

If you see the following pictures then it worked!

License

This source code is under GPL-3 open source copyright. It is the property of UCLouvain and Prof. Sandra Soares-Frazão.

Please copy the following text in your LICENCE file while using Watlab as a subpackage of your work.

Watlab - Copyright (C) <1998 – 2024> <Université catholique de Louvain (UCLouvain), Belgique> 

This program (Watlab) 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 (see COPYING file).  If not, 
see <http://www.gnu.org/licenses/>.

Development team

The development team is composed of the members of the GCE lab of Hydraulics, from UCLouvain. The contributors are:

• Nathan Delpierre
• Pierre-Yves Gousenbourger
• Robin Meurice
• Henriette Nassogne
• Martin Petitjean
• Charles Ryckmans
• Sandra Soares-Frazão (first contributor)
• Catherine Swartenbroeckx
• Sylvie Van Emelen
• Mirjana Velickovic
• Jiangtao Yang