# Pamhyr2

Pamhyr is a free and open source graphical user interface for 1D hydro-sedimentary
modelling of rivers.

## Features

+ Define a complex river hydraulics network
+ Define the river geometry
+ Define boundary conditions
+ Define lateral contribution
+ Define river friction
+ Define reservoirs
+ Define hydraulic structures
+ Define or generate initial conditions
+ Define river sedimentary layers
+ Save the study in a unique file
+ Run Mage 8 on a study and visualize results

Let see the
[documentation](https://gitlab.irstea.fr/theophile.terraz/pamhyr/-/wikis/home)
([:fr:](https://gitlab.irstea.fr/theophile.terraz/pamhyr/-/wikis/home-fr),
[:gb:](https://gitlab.irstea.fr/theophile.terraz/pamhyr/-/wikis/home-en))
for more details.

## Install

### GNU/Linux

See documentation:
- [French :fr:](https://gitlab.irstea.fr/theophile.terraz/pamhyr/-/wikis/home/fr/Install%20on%20GNULinux)
- [English :gb:](https://gitlab.irstea.fr/theophile.terraz/pamhyr/-/wikis/home/en/Install%20on%20GNULinux)

### Windows

See documentation:
- [French :fr:](https://gitlab.irstea.fr/theophile.terraz/pamhyr/-/wikis/home/fr/Install%20on%20Windows)
- [English :gb:](https://gitlab.irstea.fr/theophile.terraz/pamhyr/-/wikis/home/en/Install%20on%20Windows)

### From source code

```shell
# Get mage
mkdir mage8
cd mage8

curl -L -o mage.tgz https://gitlab.irstea.fr/jean-baptiste.faure/mage/-/releases/v8.3.6/downloads/packages/mage_linux.tgz
tar xf mage.tgz

cd ..

# Get Pamhyr2 source code
git clone https://gitlab.irstea.fr/theophile.terraz/pamhyr/
cd pamhyr

# Install dependencies
pip3 install -r requirements.txt

# Run pamhyr
./src/pamhyr.py
```