Skip to main content

Converts a zip with MODFLOW input files to a zip containing Flopy script

Project description


Converts a zip with MODFLOW input files to a zip containing Flopy script in different formats. This Flopy (Python) script can generate the intitial MODFLOW input files.

It should work for all packages of MODFLOW, MT3D, and SEAWAT. For a complete list, see the load supported packages in .

No money is to be made by the author with this package. The author has absolutely no convidense in that this script is correct and is not responsible for the content and consequences of malicious scripts. I you find it useful, please consider donating to charity (be creative in choosing which one) and send me a note (or create and close an issue). Thanks! The author is not affiliated with the modflow family nor with Flopy. This converter/generator uses the Flopy load function. Any errors/mistakes in the Flopy load functions propagate to the generated script.

Use cases

  • You are coming from a different modeling environment and want to start using Flopy

  • Clean up your flopy script/notebook

  • Add a description (and default value) to your parameters

  • Check someone else’s MODFLOW input files / Flopy script

  • Check homework assignments


  • Returns .ipynb, py, tex, html, markdown, and rst file of your MODFLOW input files

  • Consistent and clean markup is used

  • All the parameters are defined explicitely

  • A description is loaded and interpreted from the flopy package directly. The same description as in the docs ( is used.

  • Makes use of smart broadcasting to reduce the size of the arrays printed to the script.


Enter in the terminal,

$ pip install

The $-sign should be omitted, and only refers to that the command is to be entered in the bash-commandline. The flopymetascript package added to system’s $PATH and is reachable from any directory. Check if everything works by typing in any directory,

$ flopymetascript --help

Uninstall with,

$ pip uninstall flopymetascript

Please see for more information on the package structure.


Currently only tested with several MODFLOW and SEAWAT models, on a Mac-platform.

# Known issues

Example usage from the commandline:

With zipfiles

Try this first,

$ flopymetascript --outbytesfile --inbytesfile --logfile log.txt is a zip-file that contains MODFLOW input files and a single .nam file. Its content is processed and written to Some logging is written to log.txt.

Using pipes

$ openssl base64 -in -out
$ flopymetascript --outbytesfile --inbase64file is encoded to base64 and is used as input file for flopymetascript

$ flopymetascript --outbytesfile --inbase64file - <

The content of is streamed/piped to flopymetascript

$ openssl base64 -in | flopymetascript --outbytesfile --inbase64file -

The same as what is done previously, however is encoded and instead of writing it to a file, it is passed as stdin to the inbase64file argument of flopymetascript.

$ openssl base64 -in | flopymetascript --outbase64file --inbase64file - --logfile -

The log file is printed to stdout.

You cannot send both outbase64file and logfile to stdout. They will be mixed and the resulting output file is not readable.

Example usage in python

This might need somework and is subject to change in the future.

from flopymetascript.flopymetascript import process

# fn = ''
# inbase64file = open(fn, 'r')
# fn = ''
# outbase64file = open(fn, 'w')
fn = ''
inbytesfile = open(fn, 'rb')   # Dont forget the b
fn = ''
outbytesfile = open(fn, 'rb')  # Dont forget the b
fn = 'log.txt'
logfile = open(fn, 'w')

process(inbytesfile=inbytesfile, outbytesfile=outbytesfile, logfile=logfile)



  • Add additional packages with default values

  • Add a toggle to turn of the parameter description

  • Add line width as parameter

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

flopymetascript-1.0.0.tar.gz (15.9 kB view hashes)

Uploaded source

Built Distribution

flopymetascript-1.0.0-py3-none-any.whl (38.9 kB view hashes)

Uploaded 3 6

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page