# Ambhas_Cpp

> A distributed groundwater model for simulating daily evolution of the water table level.

This model has been developped during the [Atcha project](https://www6.inrae.fr/atcha/).  
It is a translation in C++ (using eigen 3.2.9) and wrapped as a [VLE](http://www.vle-project.org) model of the following existing [python package](https://pypi.org/project/ambhas/)  

The documentation of the model is available at https://record-open-archives.pages.mia.inra.fr/ambhas_cpp/

## Requirements

* [VLE-2.0.2](https://github.com/vle-forge/vle/releases/tag/v2.0.2) ([requirements](https://github.com/vle-forge/vle/tree/master2.0#requirements))
* VLE packages
  * [vle.discrete-time](https://github.com/vle-forge/packages/tree/82ee9dfbae1fb24cdbdb39ea9ff7eee19eb062fe/vle.discrete-time)
  * [ext.Eigen](https://forgemia.inra.fr/record/RECORD/-/tree/59608cf39ce147048aaafc4c516d9bc04fcd22aa/pkgs/ext.Eigen)
  * [vle.reader](https://github.com/vle-forge/packages/tree/82ee9dfbae1fb24cdbdb39ea9ff7eee19eb062fe/vle.reader)
  * [vle.tester](https://github.com/vle-forge/packages/tree/82ee9dfbae1fb24cdbdb39ea9ff7eee19eb062fe/vle.tester)

## Build/installation instructions

### Local build

Once the above requirements are met install the Ambhas_Cpp VLE package by running the following command from the root directory of this project

```shell
vle -P Ambhas_Cpp clean rclean configure build test
```
### Using docker

Alternativly a [docker](https://www.docker.com/get-started/) image satisfying all the above requirements is available in a public docker registry at registry.forgemia.inra.fr/record/record@sha256:93cb949a4228b4da336490900b523483503a07ab07eb8a3b438b66c7e75919e5.  
Once docker is installed, run an interactive container with the following command from the root directory of this project

```shell
docker run \
       --rm \
       -it \
       --user root \
       -v "$(pwd):/work" \
       registry.forgemia.inra.fr/record/record@sha256:93cb949a4228b4da336490900b523483503a07ab07eb8a3b438b66c7e75919e5 \
       bash
```

Then from inside the container run the commands

```shell
vle -P Ambhas_Cpp clean rclean configure build test
```

## Licence

GPLv3 or later. See the file Ambhas_Cpp/Licence.txt. Some files are under a different license. Check the headers for the copyright info.