Skip to content

Latest commit

 

History

History
82 lines (51 loc) · 5.63 KB

README.md

File metadata and controls

82 lines (51 loc) · 5.63 KB

River Architect logo

River Architect is an open-access, peer-reviewed (Journal SoftwareX), and Python3-based open-source software that supports river engineers and ecologists with a set of GUI modules (the last stable Python2 version can be downloaded here with sample data). The current core functionalities are:

Requirements

  • Digital terrain elevation models (DEMs).

  • 2D hydrodynamic modeling of multiple steady flow scenarios.

  • Esri's ArcPro Python environment with SpatialAnalyst license (Windows only).

Installation and Quick Usage

The quick version: Download River Architect and double-click on Start_River_Architect.bat. Modifications of the batchfile might be required, for example, to fit the conda environment. The standard environment is "%PROGRAMFILES%\ArcGIS\Pro\bin\Python\Scripts\propy", which typically refers to "C:\Program Files\ArcGIS\Pro\bin\Python\scripts\propy.bat". ArcGIS provides more information on running stand-alone Python scripts on their website.

The robust version:

  1. Download the program file directory from GitHub (or sample data).
  2. Follow the detailed Installation instructions for setting up the Environment.
  3. Read the Signposts to learn about the terminology used in River Architect and create river Conditions with the GetStarted module to start analyses.
  4. The application of River Architect's modules are described on their Wiki pages:

In addition to the module descriptions, the River Architect Wiki also provides detailed solutions for Troubleshooting.

Please note that River Architect has undergone important changes since the last stable Python2 version (download last stable Python2-River-Architect).

Documentation

The usage of River Architect is described in the River Architect's Wiki.

About

The code was developed based on data from California's Yuba River and example results can be downloaded.

Future developments will focus on improving the GUIs, developing the ModifyTerrain module for automating terraforming planning, and migrating to QGIS's Python core.

Contributing

Do not hesitate to contact river.architect.program [at] gmail.com for reporting bugs, suggestions, or any feedback.

Acknowledgment

River Architect is the result of research projects funded by