API Documentation

API documentation is provided in this section.

Input File Objects

• Project File
• Channel Input File
• Grid Pipe File
• Grid Stream File
• Hydrometeorological Files
• Map Files
• Mapping Table File
• Output Location Files
• Precipitation File
• Projection File
• Replacement File
• Snow Simulation Related Files
• Storm Pipe Network File

Output File Objects

• Generic Files
• Link Node Dataset Files
• Time Series Files
• WMS Dataset Files

Base Classes

• Gssha File Object Base
• Geometric Object Base
• Raster Object Base

GsshaPy Utilities API

• Database Tools
  • SQLite Database
  • PostgreSQL Database
  • MySQL Database

GRID API

• Land Surface Model output to GSSHA input (GRIDtoGSSHA)
• HRRR output to GSSHA input (HRRRtoGSSHA)
• ERA output to GSSHA input (ERAtoGSSHA)
• National Water Model output to GSSHA input (NWMtoGSSHA)

Modeling API

• GSSHA Framework
• GSSHA Model