modflow-setup 0.5.0.post58+g45e95f4

Modflow-setup is a Python package for automating the setup of MODFLOW groundwater models from grid-independent source data including shapefiles, rasters, and other MODFLOW models that are geo-located. Input data and model construction options are summarized in a single configuration file. Source data are read from their native formats and mapped to a regular finite difference grid specified in the configuration file. An external array-based Flopy model instance with the desired packages is created from the sampled source data and configuration settings. MODFLOW input can then be written from the flopy model instance.

Getting Started

• Philosophy
  • Motivation
  • What modflow-setup does
  • What modflow-setup doesn’t do
• Installation
  • Installing python dependencies with Conda
  • Installing Modflow-setup
  • Installing the IPython kernel to use Modflow-setup in Jupyter Notebooks
  • Best practices
  • Considerations for USGS Users
• 10 Minutes to Modflow-setup
  • 1) Define the model active area and coordinate reference system
  • 2) Create a setup script and configuration file
  • 3) Develop flowlines to represent streams
  • 4) Get a DEM
  • 5) Make a minimum working configuration file and model build script
• Examples
  • Pleasant Lake Example
• Configuration File Gallery
  • Shellmound test case
  • Shellmound TMR inset test case
  • Pleasant Lake test case
  • Pleasant Lake MODFLOW-NWT test case
  • Plainfield Lakes MODFLOW-NWT test case

User Guide

• Basic program structure and usage
  • Setting up a full model
  • Loading a model
  • Setting up individual packages
• The configuration file
  • The YAML format
  • Configuration file structure
  • Some additional notes on YAML
• Concepts and methods
  • Interpolation
  • Local grid refinement
  • Specifying perimeter boundary conditions
• Input instructions by package
  • Specifying Aquifer Properties (UPW, NPF, STO)
  • Basic stress packages (CHD, DRN, GHB, RCH, RIV, WEL)
  • The Discretization Package (DIS, TDIS, BAS6)
  • Initial Conditions (IC, BAS6)
  • The Lake Package (LAK)
  • The Streamflow Routing Package (SFR, GAGE)
  • Head observations (OBS, HYD)
  • Output Control (OC)
• Troubleshooting
  • My script doesn’t run

Reference

• Code reference
• Configuration file defaults
• Release History
• Contributing to modflow-setup

Bibliography

• References
• Modflow-setup applications
• Workflow examples