flopymetascript 1.0.0

flopymetascript

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 https://github.com/modflowpy/flopy/blob/develop/docs/supported_packages.md .

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

Advantages

• 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 (modflowpy.github.io/flopydoc/) is used.

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

Install

Enter in the terminal,

$ pip install https://github.com/bdestombe/flopymetascript/zipball/master

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 https://gehrcke.de/2014/02/distributing-a-python-command-line-application/ for more information on the package structure.

Supported

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

Example usage from the commandline:

$ flopymetascript --outbytesfile output.zip --inbytesfile input.zip --logfile log.txt

$ openssl base64 -in input.zip -out input.zip.b64
$ flopymetascript --outbytesfile output.zip --inbase64file input.zip.b64

$ flopymetascript --outbytesfile output.zip --inbase64file - < input.zip.b64

$ openssl base64 -in input.zip | flopymetascript --outbytesfile output.zip --inbase64file -

$ openssl base64 -in input.zip | flopymetascript --outbase64file utput.zip --inbase64file - --logfile -

Example usage in python

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

from flopymetascript.flopymetascript import process

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

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

inbytesfile.close()
outbytesfile.close()
logfile.close()

Todo:

• Add additional packages with default values

• Add a toggle to turn of the parameter description

• Add line width as parameter