Skip to content

Latest commit

 

History

History
70 lines (44 loc) · 3.31 KB

Readme.md

File metadata and controls

70 lines (44 loc) · 3.31 KB

modflow-setup

Package to facilitate automated setup of MODFLOW models, from 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 default settings. MODFLOW input can then be written from the flopy model instance.

Version 0.1

Build Status Build status codecov

Getting Started

For more details, see the modflow-setup documentation

Using a yaml-aware text editor, create a configuration file similar to one of the examples in the Configuration File Gallery.

The yaml file summarizes source data and parameter settings for setting up the various MODFLOW packages. To set up the model:

from mfsetup import MFnwtModel, MF6model

m = MF6model.setup_from_yaml(<path to configuration file>)

where m is a flopy MODFLOW-6 model instance that is returned. The MODFLOW input files can be written from the model instance:

m.simulation.write_simulation()

MODFLOW-NWT version:

m = MFnwtModel.setup_from_yaml(<path to configuration file>)
m.write_input()

Bugs

If you think you have discovered a bug in modflow-setup in which you feel that the program does not work as intended, then we ask you to submit a Github issue.

Installation

See the Installation Instructions

MODFLOW Resources

Disclaimer

This software is preliminary or provisional and is subject to revision. It is being provided to meet the need for timely best science. The software has not received final approval by the U.S. Geological Survey (USGS). No warranty, expressed or implied, is made by the USGS or the U.S. Government as to the functionality of the software and related material nor shall the fact of release constitute any such warranty. The software is provided on the condition that neither the USGS nor the U.S. Government shall be held liable for any damages resulting from the authorized or unauthorized use of the software.