{ "info": { "author": "Bas des Tombe", "author_email": "bdestombe@gmail.com", "bugtrack_url": null, "classifiers": [ "Development Status :: 4 - Beta", "License :: OSI Approved :: BSD License", "License :: OSI Approved :: MIT License", "Natural Language :: English", "Programming Language :: Python :: 3 :: Only", "Topic :: Scientific/Engineering" ], "description": "flopymetascript\n===============\n\nConverts a zip with MODFLOW input files to a zip containing Flopy script\nin different formats. This Flopy (Python) script can generate the\nintitial MODFLOW input files.\n\nIt should work for all packages of MODFLOW, MT3D, and SEAWAT. For a\ncomplete list, see the load supported packages in\nhttps://github.com/modflowpy/flopy/blob/develop/docs/supported\\_packages.md\n.\n\nNo money is to be made by the author with this package. The author has\nabsolutely no convidense in that this script is correct and is not\nresponsible for the content and consequences of malicious scripts. I you\nfind it useful, please consider donating to charity (be creative in\nchoosing which one) and send me a note (or create and close an issue).\nThanks! The author is not affiliated with the modflow family nor with\nFlopy. This converter/generator uses the Flopy load function. Any\nerrors/mistakes in the Flopy load functions propagate to the generated\nscript.\n\nUse cases\n=========\n\n- You are coming from a different modeling environment and want to\n start using Flopy\n- Clean up your flopy script/notebook\n- Add a description (and default value) to your parameters\n- Check someone else's MODFLOW input files / Flopy script\n- Check homework assignments\n\nAdvantages\n==========\n\n- Returns .ipynb, py, tex, html, markdown, and rst file of your MODFLOW\n input files\n- Consistent and clean markup is used\n- All the parameters are defined explicitely\n- A description is loaded and interpreted from the flopy package\n directly. The same description as in the docs\n (modflowpy.github.io/flopydoc/) is used.\n- Makes use of smart broadcasting to reduce the size of the arrays\n printed to the script.\n\nInstall\n=======\n\nEnter in the terminal,\n\n.. code:: bash\n\n $ pip install https://github.com/bdestombe/flopymetascript/zipball/master\n\nThe ``$``-sign should be omitted, and only refers to that the command is\nto be entered in the bash-commandline. The flopymetascript package added\nto system's ``$PATH`` and is reachable from any directory. Check if\neverything works by typing in any directory,\n\n.. code:: bash\n\n $ flopymetascript --help\n\nUninstall with,\n\n.. code:: bash\n\n $ pip uninstall flopymetascript\n\nPlease see\nhttps://gehrcke.de/2014/02/distributing-a-python-command-line-application/\nfor more information on the package structure.\n\nSupported\n=========\n\nCurrently only tested with several MODFLOW and SEAWAT models, on a\nMac-platform.\n\n# Known issues\n--------------\n\nExample usage from the commandline:\n===================================\n\nWith zipfiles\n-------------\n\nTry this first,\n\n.. code:: bash\n\n $ flopymetascript --outbytesfile output.zip --inbytesfile input.zip --logfile log.txt\n\ninput.zip is a zip-file that contains MODFLOW input files and a single\n.nam file. Its content is processed and written to output.zip. Some\nlogging is written to log.txt.\n\nUsing pipes\n-----------\n\n.. code:: bash\n\n $ openssl base64 -in input.zip -out input.zip.b64\n $ flopymetascript --outbytesfile output.zip --inbase64file input.zip.b64\n\ninput.zip is encoded to base64 and is used as input file for\nflopymetascript\n\n.. code:: bash\n\n $ flopymetascript --outbytesfile output.zip --inbase64file - < input.zip.b64\n\nThe content of input.zip.b64 is streamed/piped to flopymetascript\n\n.. code:: bash\n\n $ openssl base64 -in input.zip | flopymetascript --outbytesfile output.zip --inbase64file -\n\nThe same as what is done previously, however input.zip is encoded and\ninstead of writing it to a file, it is passed as stdin to the\ninbase64file argument of flopymetascript.\n\n.. code:: bash\n\n $ openssl base64 -in input.zip | flopymetascript --outbase64file utput.zip --inbase64file - --logfile -\n\nThe log file is printed to stdout.\n\nYou cannot send both outbase64file and logfile to stdout. They will be\nmixed and the resulting output file is not readable.\n\nExample usage in python\n=======================\n\nThis might need somework and is subject to change in the future.\n\n.. code:: python\n\n from flopymetascript.flopymetascript import process\n\n # fn = 'input.zip.b64'\n # inbase64file = open(fn, 'r')\n # fn = 'output.zip.b64'\n # outbase64file = open(fn, 'w')\n fn = 'input.zip'\n inbytesfile = open(fn, 'rb') # Dont forget the b\n fn = 'output.zip'\n outbytesfile = open(fn, 'rb') # Dont forget the b\n fn = 'log.txt'\n logfile = open(fn, 'w')\n\n process(inbytesfile=inbytesfile, outbytesfile=outbytesfile, logfile=logfile)\n\n inbytesfile.close()\n outbytesfile.close()\n logfile.close()\n\nTodo:\n=====\n\n- Add additional packages with default values\n- Add a toggle to turn of the parameter description\n- Add line width as parameter\n", "description_content_type": null, "docs_url": null, "download_url": "https://github.com/bdestombe/flopymetascript/archive/1.0.0.tar.gz", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/bdestombe/flopymetascript", "keywords": "flopy", "license": "MIT", "maintainer": "", "maintainer_email": "", "name": "flopymetascript", "package_url": "https://pypi.org/project/flopymetascript/", "platform": "Windows", "project_url": "https://pypi.org/project/flopymetascript/", "project_urls": { "Download": "https://github.com/bdestombe/flopymetascript/archive/1.0.0.tar.gz", "Homepage": "https://github.com/bdestombe/flopymetascript" }, "release_url": "https://pypi.org/project/flopymetascript/1.0.0/", "requires_dist": null, "requires_python": "", "summary": "Converts a zip with MODFLOW input files to a zip containing Flopy script", "version": "1.0.0" }, "last_serial": 2862182, "releases": { "0.2.1": [ { "comment_text": "", "digests": { "md5": "f44e3a566e272431c83d9a1abdb7c5b1", "sha256": "d07f84d11ba594c644d4803c7c1f6d8eed29a801772cefe322f63359a70195e6" }, "downloads": -1, "filename": "flopymetascript-0.2.1-py3-none-any.whl", "has_sig": false, "md5_digest": "f44e3a566e272431c83d9a1abdb7c5b1", "packagetype": "bdist_wheel", "python_version": "3.6", "requires_python": null, "size": 39862, "upload_time": "2017-05-09T08:49:12", "url": "https://files.pythonhosted.org/packages/6e/26/e4097390bd8e9808210ca7931f05df694dff4721e3667bc5bee6067d420a/flopymetascript-0.2.1-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "0efa13a0f6d50dd2fbf192b6188cd583", "sha256": "c9dbf8e74a77af93882bfcdac49c224ab59a4df1005d0c793fa8a752d0fc4059" }, "downloads": -1, "filename": "flopymetascript-0.2.1.tar.gz", "has_sig": false, "md5_digest": "0efa13a0f6d50dd2fbf192b6188cd583", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 16352, "upload_time": "2017-05-09T08:49:02", "url": "https://files.pythonhosted.org/packages/d2/3d/fefac907d952214dc615171b98f788aee30e5011de874200230b8138eb33/flopymetascript-0.2.1.tar.gz" } ], "0.3.1": [ { "comment_text": "", "digests": { "md5": "3299fff49e613a38a9e0fb18bc8fe3e2", "sha256": "cd80485ced13f97f0d0dfe5148951e3b509acef604e30f042e989da8b3f669b1" }, "downloads": -1, "filename": "flopymetascript-0.3.1-py3-none-any.whl", "has_sig": false, "md5_digest": "3299fff49e613a38a9e0fb18bc8fe3e2", "packagetype": "bdist_wheel", "python_version": "3.6", "requires_python": null, "size": 38945, "upload_time": "2017-05-09T12:25:27", "url": "https://files.pythonhosted.org/packages/d6/ad/079261fbb507ebb0dbf49474aeef23d66120a767ecc885af825c4949c508/flopymetascript-0.3.1-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "73c66a12d99d15258e3209e930c0ac59", "sha256": "bf8426039a8ac19a5ecbbe4a8203f303a09be55a62b705e71a25d75a6d10d543" }, "downloads": -1, "filename": "flopymetascript-0.3.1.tar.gz", "has_sig": false, "md5_digest": "73c66a12d99d15258e3209e930c0ac59", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 15861, "upload_time": "2017-05-09T12:25:13", "url": "https://files.pythonhosted.org/packages/64/e6/edbda372a442963f844af710cd6d84f1bcad4f15abccd1ada2cad1b76d52/flopymetascript-0.3.1.tar.gz" } ], "1.0.0": [ { "comment_text": "", "digests": { "md5": "6265f6abd4f8a8f6468964f31eafd68d", "sha256": "126174cb2471e6f4daad1d70fc0c7893c48166cc7412cd802279196570ece321" }, "downloads": -1, "filename": "flopymetascript-1.0.0-py3-none-any.whl", "has_sig": false, "md5_digest": "6265f6abd4f8a8f6468964f31eafd68d", "packagetype": "bdist_wheel", "python_version": "3.6", "requires_python": null, "size": 38941, "upload_time": "2017-05-09T17:10:07", "url": "https://files.pythonhosted.org/packages/e3/8a/98e1f08173c5bddcbc6109d8b47a8bbbb932b007645b1053b131aadbf318/flopymetascript-1.0.0-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "100f7ac106fb8b3100825d01b142aaaf", "sha256": "a2fbfb48bb7ebaf188b908fee1f0d52ffd5fb77473270fb61bf8d636ef820076" }, "downloads": -1, "filename": "flopymetascript-1.0.0.tar.gz", "has_sig": false, "md5_digest": "100f7ac106fb8b3100825d01b142aaaf", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 15861, "upload_time": "2017-05-09T17:09:58", "url": "https://files.pythonhosted.org/packages/21/cb/ef34aa1b998c060d3425c0328c41b2638a7aed9e2591b0900250b76252a4/flopymetascript-1.0.0.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "6265f6abd4f8a8f6468964f31eafd68d", "sha256": "126174cb2471e6f4daad1d70fc0c7893c48166cc7412cd802279196570ece321" }, "downloads": -1, "filename": "flopymetascript-1.0.0-py3-none-any.whl", "has_sig": false, "md5_digest": "6265f6abd4f8a8f6468964f31eafd68d", "packagetype": "bdist_wheel", "python_version": "3.6", "requires_python": null, "size": 38941, "upload_time": "2017-05-09T17:10:07", "url": "https://files.pythonhosted.org/packages/e3/8a/98e1f08173c5bddcbc6109d8b47a8bbbb932b007645b1053b131aadbf318/flopymetascript-1.0.0-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "100f7ac106fb8b3100825d01b142aaaf", "sha256": "a2fbfb48bb7ebaf188b908fee1f0d52ffd5fb77473270fb61bf8d636ef820076" }, "downloads": -1, "filename": "flopymetascript-1.0.0.tar.gz", "has_sig": false, "md5_digest": "100f7ac106fb8b3100825d01b142aaaf", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 15861, "upload_time": "2017-05-09T17:09:58", "url": "https://files.pythonhosted.org/packages/21/cb/ef34aa1b998c060d3425c0328c41b2638a7aed9e2591b0900250b76252a4/flopymetascript-1.0.0.tar.gz" } ] }