Welcome to the pyHS2MF6 documentation

pyHS2MF6 is an integrated hydrologic model created using a dynamic coupling of HSPF and MODFLOW 6 in Python. The coupling is dynamic because HSPF and MODFLOW 6 exchange information during each simulation time step. At this time, pyHS2MF6 can only use and simulate the basic water movement and storage processes in HSPF and MODFLOW.

A fundamental goal in the design of pyHS2MF6 was to provide for the ability to build on existing, independently created, HSPF and MODFLOW models. Consequently, pyHS2MF6 provides two simulation modes.

1. Coupled mode: Main simulation mode with dynamically coupled HSPF and MODFLOW 6

2. Standalone mode: Included purely so that the user can check or verify the function of the independent, existing model (either HSPF or MODFLOW 6) in pyHS2MF6. It is not recommended to use pyHS2MF6 standalone mode in place of just using HSPF or just using MODFLOW 6.

pyHS2MF6 coupling of HSPF and MODFLOW 6

In Figure pyHS2MF6 coupling of HSPF and MODFLOW 6 arrows are shown representing flow between HSPF and MODFLOW 6. The spatial mapping component translates between the HSPF lumped parameter representation of watersheds and stream segments, represented with a single arrow in the diagram, and the three-dimensional, computational grid representation of MODFLOW 6, represented with multiple arrows in the diagram. pyHS2MF6 simulates and accounts for flows in both directions: 1) from HSPF to MODFLOW 6 and 2) from MODFLOW 6 to HSPF.

Attention

pyHS2MF6 source code is available from the project GitHub site.

Please see Getting Started with pyHS2MF6 before trying to install and run pyHS2MF6.

It is recommended to at least browse through the Coupled Mode Example Model before trying to apply pyHS2MF6 to a specific site.

Note

pyHS2MF6 is available for free under the GNU Affero General Public License version 3 and without warranty or support.

• Technical support can be arranged, if desired.

• pyHS2MF6 builds upon and extends two independent models and provides for dynamic information exchange between the models. As a result, pyHS2MF6 configuration, implementation, and use requires a number of prerequisites.

Table of Contents

• 1. Getting Started with pyHS2MF6
  • 1.1. Python Programming
  • 1.2. Next Steps
• 2. Installation
  • 2.1. Install and Configure a Python Environment
  • 2.2. Install a Compiler and Build DLLs
• 3. Coupled Mode Example Model
  • 3.1. Study Site
  • 3.2. Standalone HSPF Model
  • 3.3. Standalone MODFLOW 6 Model
  • 3.4. Coupled Mode Simulation and Results
• 4. Code Documentation
  • 4.1. Coupled Model Controller and Queue Server
  • 4.2. mHSP2
  • 4.3. pyMF6

Indices and tables

• Index

• Module Index

• Search Page