pyHMT2D: a Python tool library for two-dimensional hydraulic modeling

This is a short documentation of pyHMT2D and its API. More detailed information about how to use pyHMT2D, algoritms, implementations, and some of the theoretical background are in the user manual.

Contents:

• pyHMT2D - Python-based Hydraulic Modeling Tools - 2D
• Supported Platform
• Motivations
• Features
• Installation
  • Prerequisites
  • Clone and install in a development environment (recommended)
• Example Usage (see the “examples” directory for more details)
  • Use in your own Python code (more flexibility)
  • Command line interface (CLI)
• Limitations
• API Documentation
• Acknowledgements and References
• License
• Author
• Contributors and Contributor Agreement
  • The list of contributors:
  • Contributor agreement
• How to cite pyHMT2D
• pyHMT2D API
  • pyHMT2D base classes, constants, and tools
    • HydraulicData
    • HydraulicModel
    • gMax_Nodes_per_Element
    • gMax_Elements_per_Node
  • Backwater-1D related classes and tools
    • Backwater_1D_Data
    • Backwater_1D_Model
  • SRH-2D related classes and tools
    • SRH_2D_Data
    • SRH_2D_Model
    • SRH_2D_SIF
    • SRH_2D_SRHGeom
    • SRH_2D_SRHHydro
    • SRH_2D_SRHMat
  • HEC-RAS related classes and tools
    • HEC_RAS_Model
    • RAS_2D_Data
  • Miscellaneous classes and tools
    • RAS_to_SRH_Converter
    • Terrain
    • gmsh2d_to_srh()

Indices and tables

• Index

• Module Index

• Search Page