Skip to content

tamnva/hydroecolstm

Repository files navigation

HydroEcoLSTM

Documentation Status DOI PyPI Latest Release

  • HydroEcoLSTM is a Python package with a graphical user interface (GUI) for modeling hydro-ecological processes using Long short-term Memory (LSTM) neural network.
  • Please check the package documentation for more details, especially about how to use HydroEcoLSTM without the GUI.
  • Here is the YouTube channel for tutorial videos on how to use HydroEcoLSTM with GUI.
  • If you have any questions or want to report any issues, you can either report it in GitHub or HydroEcoLSTM Google group.

Nguyen, T.V., Tran, V.N., Tran, H., Binh, D.V., Duong, T.D., Dang, T.D., Ebeling, P. (2025). HydroEcoLSTM: A Python package with graphical user interface for hydro-ecological modeling with long short-term memory neural network. Ecological Informatics, 102994. 10.1016/j.ecoinf.2025.102994.

Quick start

Installation with Anaconda using environment (environment.yml) file following the steps listed below. You can also see my tutorial videos 1 and 7 for more details on how to install Anaconda and create a virtual environment.

# 1. Create the environment from environment.yml file (see link above)
conda env create -f environment.yml
conda activate hydroecolstm_env

# 2. Install the lastest version from github
pip install git+https://github.com/tamnva/hydroecolstm.git

# Or Install from PyPI (stable version)
pip install hydroecolstm

# 3. Import the package and show the GUI (please see below)
import hydroecolstm
hydroecolstm.interface.show_gui()

The GUI

  • After launchthe ing the GUI, you should see the following window (the latest version could look different). Two examples were documented in these files