ANNESI-web: Artificial neural network for estuarine salt intrusion web-API

This repository contains the web-API of the open-source artificial neural network for estuarine salt intrusion (ANNESI) and is part of the same PhD research on developing nature-based solutions to mitigate salt intrusion (for more information, see the central repository).

As stated in the home-repository of ANNESI, part of this research is a sensitivity analysis of estuarine salt intrusion to estuarine characteristics. As a by-product of the sensitivity analysis, a neural network has been trained to the elaborate data set created, consisting of more than 1,250 simulations with Delft3D Flexible Mesh (specifically the D-Flow module).

The neural network is available as a stand-alone piece of code in Python for which the home-repository of ANNESI should be consulted. This repository contains the JavaScript-code to allow hosting this neural network as a web-API, which is hosted with netlify.

Usage

The easiest way of using this web-API is by visiting the hosting website: ANNESI-web. Otherwise, this repository can be downloaded and the web-page can be launched locally, i.e. index.html.

Structure

The essential pieces of code for the web-API are located in the src-folder, including the data reflecting the neural network itself, which is stored as *.onnx-file in the _data-folder:

+-- src/
|   +-- _data/
|   |   +-- annesi.onnx
|   |   +-- annesi-onnx.txt
|   +-- check.js
|   +-- config.js
|   +-- display.js
|   +-- exec.js
|   +-- model.js
|   +-- visuals.js
+-- .gitignore
+-- index.html
+-- LICENSE
+-- main.css
+-- main.js
+-- README.md

Author

Gijs G. Hendrickx 0000-0001-9523-7657 (Delft University of Technology).

Contact: G.G.Hendrickx@tudelft.nl.

References

When using this repository and the underlying neural network (i.e. ANNESI), please consider citing the neural network software:

Hendrickx, G.G. (2022). ANNESI: An open-source artificial neural network for estuarine salt intrusion. 4TU.ResearchData. Software. doi:10.4121/19307693.

Version-control

The neural network, and so the web-API, are subject to updates. These updates are reflected by different versions of the repository. For the latest updates on the neural network, see the original repository: ANNESI. Changes related to the web-API are reflected by different versions of this repository.

License

This repository is licensed under Apache License 2.0.