API Reference

This section contains the complete API documentation for pyiwfm. Each page below provides detailed class, function, and attribute documentation generated from source code docstrings.

• Core Modules
  • Mesh Module
  • Stratigraphy Module
  • Time Series Module
  • Base Component
  • Model Module
  • Model Factory
  • Zones Module
  • Aggregation Module
  • Mesh Quality
  • Query Module
• Component Modules
  • Groundwater Module
  • Stream Module
  • Lake Module
  • Root Zone Module
  • Small Watershed Module
  • Unsaturated Zone Module
  • Connectors Module
• I/O Modules
  • Core I/O
  • PreProcessor I/O
  • Simulation I/O
  • Groundwater I/O
  • Stream I/O
  • Lake I/O
  • Root Zone I/O
  • Supplemental Package I/O
  • Time Series I/O
  • Budget / Results I/O
  • Model I/O
  • Infrastructure
  • HEC-DSS Module
  • Data Loaders
  • Observation File I/O
  • Zone File I/O
• Mesh Generation
  • Generators Module
  • Constraints Module
  • Triangle Wrapper
  • Gmsh Wrapper
• Visualization
  • GIS Export
  • VTK Export
  • Plotting
  • Interactive Web Viewer
• Calibration
  • IWFM2OBS
  • Model File Discovery
  • Observation Well Specification
  • Typical Hydrographs (CalcTypHyd)
  • Fuzzy C-Means Clustering
  • Headall Extraction
  • Results Extraction
  • Calibration Plots
  • PEST CLI
• Comparison
  • Differ Module
  • Metrics Module
  • Report Module
• Runner and PEST++ Integration
  • Runner Module
  • Results Module
  • Scenario Module
  • PEST++ Interface
  • Parameter Management
  • Observation Management
  • Template and Instruction Files
  • Geostatistics
  • Main Helper Interface
  • Ensemble Management
  • Post-Processing
• Roundtrip and CLI Modules
  • Roundtrip Pipeline
  • Roundtrip Configuration
  • Run Script Generator
  • Model Packager
  • Executable Manager
  • Results Differ
  • CLI Subcommands