{ "info": { "author": "Fedor Baart", "author_email": "fedor.baart@deltares.nl", "bugtrack_url": null, "classifiers": [ "Intended Audience :: Science/Research", "License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)", "Programming Language :: Python :: 2", "Programming Language :: Python :: 2.7", "Programming Language :: Python :: 3", "Programming Language :: Python :: 3.5", "Topic :: Scientific/Engineering", "Topic :: Software Development :: Libraries" ], "description": "Python wrapper for BMI models\n==========================================\n\nThis is ctypes wrapper for BMI models.\n\nThe BMI_ describes a low level interface for numerical models.\n\n.. image:: https://travis-ci.org/openearth/bmi-python.svg?branch=master\n :target: https://travis-ci.org/openearth/bmi-python\n \nOrigin\n------\nThis module is based on code from:\n\n- CSMDS: https://csdms.colorado.edu/svn/bmi/trunk/python/bmi/BMI.py\n- OpenEarth: http://svn.oss.deltares.nl/repos/openearthtools/trunk/python/OpenEarthTools\n- 3Di: https://github.com/nens/python-subgrid\n\nModels\n------\nSeveral models implement the BMI_ interface.\n\n- Subgrid: https://github.com/nens/python-subgrid\n- Swan: https://github.com/SiggyF/chenopis\n- XBeach: http://svn.oss.deltares.nl/repos/xbeach\n- DFlow-FM: https://repos.deltares.nl/repos/ds/trunk/additional/unstruc/python/dflowfm\n\nPrerequisites\n-------------\n\nWe need a compiled BMI library (dll, so, dylib). There are a couple of common\nlocations where we look for it.::\n\n .\n ~/local/lib\n ~/.local/lib\n /opt/modelname/lib\n /usr/local/lib\n /usr/lib\n\nA convention on linux is to install the library into ``/opt/modelname/``.\nIf you are using one of the models above, the modelname will be 3di, dflowfm, xbeach or swan\n\nIn case you have an alternative location, you can set the ``LD_LIBRARY_PATH``, (``DYLD_LIBRARY_PATH`` in OSX, ``PATH`` in windows)\nenvironment variable, for example for 3Di::\n\n $ export LD_LIBRARY_PATH=/home/user/svn/3di/trunk/subgridf90/src/.libs\n\n(On windows the command is ``set`` instead of ``export``).\n\nSetup\n------\n\nThe virtualenv way (assumes virtualenvwrapper and virtualenv are installed)::\n\n mkvirtualenv main\n workon main\n # get the version from pypi\n pip install bmi\n # or if you want to add your source directory to the path\n pip install -e .\n\nCombination Windows and Anaconda::\n\n- Download + Install Anaconda\n- Download and install the :faulthandler: package, from http://www.lfd.uci.edu/~gohlke/pythonlibs/#faulthandler\n- Download and install the :NetCDF4: package, from http://www.lfd.uci.edu/~gohlke/pythonlibs/#netcdf4\n- Open an (Anaconda) Python-terminal (Press :[Ctrl]:+:[Alt]+:A:).\n- pip.bat install -e ````\n\n\nUsage\n-----\n\nThere are two ways to use the wrapper. A handy way is as a context\nmanager, so with a ``with`` statement::\n\n with BMIWrapper(engine=\"model\", configfile='/full/path/model.ini') as model:\n # model is the actual library.\n model.something()\n\nThe second way is by calling :meth:`start` and :meth:`stop` yourself and\nusing the :attr:`library` attribute to access the Fortran library::\n\n wrapper = BMIWrapper(engine=\"model\", configfile='/full/path/model.mdu')\n wrapper.start()\n wrapper.library.something()\n ...\n wrapper.stop()\n\nNote: Without the ``mdu`` argument, no model is loaded and you're free to\nuse the library as you want.\n\n\nConvenience scripts\n-------------------\n\nThe python bmi library contains a script that can be used as a command line runner for your model::\n\n bmi-runner \n\nLinks\n--------\n.. _BMI: http://csdms.colorado.edu/wiki/BMI_Description\n\n\nCredits\n=======\n\n- Fedor Baart\n- Gena Donchyts\n- Jack Ha\n- Stef Hummel\n- Scott Peckham\n- Reinout van Rees\n- Sander Smits\n\n\nChangelog of bmi-python\n===================================================\n\n\n2014-02-07\n----------\n\n- allow relative path for config_file\n- fix exception when unicode is used as variable names\n\n0.1 (2014-04-01)\n----------------\n\n- Split of code from python-subgrid and openearthtools in general BMI wrapper.\n", "description_content_type": "", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/openearth/bmi-python", "keywords": "hydrodynamic", "license": "GPLv3+", "maintainer": "", "maintainer_email": "", "name": "bmi-python", "package_url": "https://pypi.org/project/bmi-python/", "platform": "", "project_url": "https://pypi.org/project/bmi-python/", "project_urls": { "Homepage": "https://github.com/openearth/bmi-python" }, "release_url": "https://pypi.org/project/bmi-python/0.2.7/", "requires_dist": null, "requires_python": "", "summary": "Python wrapper for BMI libraries", "version": "0.2.7" }, "last_serial": 3890792, "releases": { "0.2.5": [ { "comment_text": "", "digests": { "md5": "23a5baf971ff51a05c32610433cb8823", "sha256": "64c142e32b418b9068ca2b761e96872d460c6d67ee9c93262b0a35357f69f9ca" }, "downloads": -1, "filename": "bmi_python-0.2.5-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "23a5baf971ff51a05c32610433cb8823", "packagetype": "bdist_wheel", "python_version": "3.5", "requires_python": null, "size": 15803, "upload_time": "2017-06-28T13:30:33", "url": "https://files.pythonhosted.org/packages/5c/3a/a58f052214b2963ebd700127c27b0ee8618b1c67c9612c82fd646df0820c/bmi_python-0.2.5-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "88766b6df5ea9e3167c8df7ad339b807", "sha256": "c6f628beec24a46378917eae477021ec6dcaf9938c86bce8b77b413bf8886501" }, "downloads": -1, "filename": "bmi-python-0.2.5.tar.gz", "has_sig": false, "md5_digest": "88766b6df5ea9e3167c8df7ad339b807", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 12240, "upload_time": "2017-06-28T13:30:31", "url": "https://files.pythonhosted.org/packages/0d/f5/6659c118355f537b89dd52f4e945adf464ad26a4427384a44ef8a8e05d0a/bmi-python-0.2.5.tar.gz" } ], "0.2.6": [ { "comment_text": "", "digests": { "md5": "531793cb4400b0d7471c430eaf682f31", "sha256": "0c343b03bdcffeee63ff1700e3ec336829c04793bd78f37b507c49036133c806" }, "downloads": -1, "filename": "bmi_python-0.2.6-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "531793cb4400b0d7471c430eaf682f31", "packagetype": "bdist_wheel", "python_version": "3.5", "requires_python": null, "size": 15805, "upload_time": "2017-07-03T08:48:05", "url": "https://files.pythonhosted.org/packages/7d/cb/e2a899253630a169144c4f4cf753f0d5bb8c548d456b0133ac518b282008/bmi_python-0.2.6-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "7509ea9faa8d042a599d86f89f4b1999", "sha256": "9777d27fa2ce861fc86483df3655aac45b239d3112ccbbc431011e8d272ffb4b" }, "downloads": -1, "filename": "bmi-python-0.2.6.tar.gz", "has_sig": false, "md5_digest": "7509ea9faa8d042a599d86f89f4b1999", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 12247, "upload_time": "2017-07-03T08:48:02", "url": "https://files.pythonhosted.org/packages/c4/ea/9379d4ea5bead29f4d60c68be6c30bef157d8dde95f03988fa2fb0def883/bmi-python-0.2.6.tar.gz" } ], "0.2.7": [ { "comment_text": "", "digests": { "md5": "35c0ec40c722328d83aeb62d4e64f83f", "sha256": "cea6c73b554d71ce921712fd9019160cad4a0edc818ec1315642ec5fc01d5899" }, "downloads": -1, "filename": "bmi_python-0.2.7-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "35c0ec40c722328d83aeb62d4e64f83f", "packagetype": "bdist_wheel", "python_version": "3.6", "requires_python": null, "size": 15799, "upload_time": "2018-05-23T10:05:16", "url": "https://files.pythonhosted.org/packages/7e/15/20c3488b8886fb9a119a1f3cf63540e37bfa40bed703cfce690d9d9c7546/bmi_python-0.2.7-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "0a0f1d448a41e2f5f8c4c4ca7a037050", "sha256": "a197fa967921d98a45a3d84b015883d175f6e531d81be914eb12d1c5285ae968" }, "downloads": -1, "filename": "bmi-python-0.2.7.tar.gz", "has_sig": false, "md5_digest": "0a0f1d448a41e2f5f8c4c4ca7a037050", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 12239, "upload_time": "2018-05-23T10:05:14", "url": "https://files.pythonhosted.org/packages/ef/20/973341e34e13099cec4bac6a08eca469f7612e9cc345461180642902f9e8/bmi-python-0.2.7.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "35c0ec40c722328d83aeb62d4e64f83f", "sha256": "cea6c73b554d71ce921712fd9019160cad4a0edc818ec1315642ec5fc01d5899" }, "downloads": -1, "filename": "bmi_python-0.2.7-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "35c0ec40c722328d83aeb62d4e64f83f", "packagetype": "bdist_wheel", "python_version": "3.6", "requires_python": null, "size": 15799, "upload_time": "2018-05-23T10:05:16", "url": "https://files.pythonhosted.org/packages/7e/15/20c3488b8886fb9a119a1f3cf63540e37bfa40bed703cfce690d9d9c7546/bmi_python-0.2.7-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "0a0f1d448a41e2f5f8c4c4ca7a037050", "sha256": "a197fa967921d98a45a3d84b015883d175f6e531d81be914eb12d1c5285ae968" }, "downloads": -1, "filename": "bmi-python-0.2.7.tar.gz", "has_sig": false, "md5_digest": "0a0f1d448a41e2f5f8c4c4ca7a037050", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 12239, "upload_time": "2018-05-23T10:05:14", "url": "https://files.pythonhosted.org/packages/ef/20/973341e34e13099cec4bac6a08eca469f7612e9cc345461180642902f9e8/bmi-python-0.2.7.tar.gz" } ] }