{ "info": { "author": "Jeremy Bennett", "author_email": "hyvr.sim@gmail.com", "bugtrack_url": null, "classifiers": [ "Development Status :: 3 - Alpha", "Intended Audience :: Education", "Intended Audience :: End Users/Desktop", "Intended Audience :: Science/Research", "License :: OSI Approved :: MIT License", "Programming Language :: Python :: 3", "Topic :: Scientific/Engineering" ], "description": "====================================================================\nIntroduction\n====================================================================\n\n**HyVR: Turning your geofantasy into reality!** \n\nThe Hydrogeological Virtual Reality simulation package (HyVR) is a Python module\nthat helps researchers and practitioners generate subsurface models with\nmultiple scales of heterogeneity that are based on geological concepts. The\nsimulation outputs can then be used to explore groundwater flow and solute\ntransport behaviour. This is facilitated by HyVR outputs in common flow\nsimulation packages' input formats. As each site is unique, HyVR has been\ndesigned that users can take the code and extend it to suit their particular\nsimulation needs.\n\nThe original motivation for HyVR was the lack of tools for modelling sedimentary\ndeposits that include bedding structure model outputs (i.e., dip and azimuth).\nSuch bedding parameters were required to approximate full hydraulic-conductivity\ntensors for groundwater flow modelling. HyVR is able to simulate these bedding\nparameters and generate spatially distributed parameter fields, including full\nhydraulic-conductivity tensors. More information about HyVR is available in the\nonline `technical documentation `_.\n\nI hope you enjoy using HyVR much more than I enjoyed putting it together! I look\nforward to seeing what kind of funky fields you created in the course of your\nwork.\n\n*HyVR can be attributed by citing the following journal article: Bennett, J. P.,\nHaslauer, C. P., Ross, M., & Cirpka, O. A. (2018). An open, object-based\nframework for generating anisotropy in sedimentary subsurface\nmodels. Groundwater.\nDOI:* `10.1111/gwat.12803 `_.\n*A preprint version of the article is available* `here `_.\n\nInstalling the HyVR package\n--------------------------------------\n\nInstalling Python\n^^^^^^^^^^^^^^^^^\n\n\nWindows\n\"\"\"\"\"\"\"\n\nIf you are using Windows, we recommend installing the `Anaconda distribution\n`_ of Python 3. This distribution has the\nmajority of dependencies that HyVR requires.\n\nIt is also a good idea to install the HyVR package into a `virtual environment\n`_. Do this by\nopening a command prompt window and typing the following::\n\n conda create --name hyvr_env\n\nYou need to then activate this environment::\n\n conda activate hyvr_env\n\t\n\nLinux\n\"\"\"\"\"\n\nDepending on your preferences you can either use the Anaconda/Miniconda\ndistribution of python, or the version of your package manager. If you choose\nthe former, follow the same steps as for Windows.\n\nIf you choose the latter, you probably already have Python 3 installed. If not,\nyou can install it using your package manager (e.g. ``apt`` on Ubuntu/Debian).\n\nIn any way we recommend using a virtual environment. Non-conda users can use for\nexample `virtualenvwrapper `_.\n\n\nInstalling HyVR\n^^^^^^^^^^^^^^^\n\nOnce you have activated your virtual environment, you can install HyVR from PyPI\nusing ``pip`` (with Anaconda you might have to install pip first into your\nenvironment using ``conda install pip``)::\n\n pip install hyvr\n\nIt might be necessary to install numpy separately before installing HyVR.\nTo check whether installation was successful, you can run::\n\n python -m hyvr\n\nIf this runs without error (warnings are ok), ``hyvr`` should be successfully\ninstalled.\n\nIf installing from PyPI doesn't work for you, please let us know (see\nbelow). You might want to try installing from source instead.\n\nInstallation from conda-forge will (hopefully) be coming soon.\n\nInstalling from source\n\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\n\nIf installation via ``pip`` fails, you can try to install from source by cloning\nor downloading the github repository.\nTo install from source you need a C/C++ compiler. On Windows you can get one by\ninstalling \"Build Tools for Visual Studio\".\nIf you have ``git`` installed on your machine, you can do::\n\n git clone https://github.com/driftingtides/hyvr.git\n pip install ./hyvr\n\nOtherwise you can download the code as a zip file, unzip it, and then install it via::\n\n pip install \n\nIf you are in the same directory as the unzipped ``hyvr`` directory make sure to\nuse ``./hyvr`` instead of ``hyvr``, otherwise pip tries to install from PyPI.\n\n\nDependencies\n^^^^^^^^^^^^\n\n``pip`` should normally install all required dependencies. Optional dependencies are:\n\n- ``Cython`` to recreate the C-extensions\n- ``h5py`` for HDF5 output\n- ``flopy`` for output of MODFLOW files\n- ``pyevtk`` for VTR output\n\n\nUsage\n-----\n\nTo use HyVR you have to create a configuration file with your settings.\nYou can then run HyVR the following way::\n\n (hyvr_env) $ python -m hyvr my_configfile.ini\n\nHyVR will then run and store all results in a subdirectory. If no configfile is\ngiven, it will run a test case instead::\n\n (hyvr_env) $ python -m hyvr\n\nIf you want to use HyVR in a script, you can import it and use the ``run`` function::\n\n import hyvr\n hyvr.run('my_configfile.ini')\n \nExamples can be found in the ``tests/testcases`` directory of the `github\nrepository `_, the general setup and\npossible options of the config-file are described in the\ndocumentation. Currently only ``tests/testcaes/made.ini`` is ported to version 1.0.0.\n\n\nDevelopment\n-----------\nHyVR has been developed by Jeremy Bennett (`website `_)\nas part of his doctoral research at the University of T\u00fcbingen and by Samuel\nScherrer as a student assistant.\n\nYou can contact the developer(s) of HyVR by `email `_\nor via github.\n\nProblems, Bugs, Unclear Documentation\n-------------------------------------\n\nIf you have problems with HyVR have a look at the `troubleshooting\n`_ section. If this\ndoesn't help, don't hesitate to contact us via email or at github.\n\nIf you find that the documentation is unclear, lacking, or wrong, please also\ncontact us.", "description_content_type": "text/x-rst", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/driftingtides/hyvr", "keywords": "hydrogeology,sediment,simulator", "license": "MIT", "maintainer": "", "maintainer_email": "", "name": "hyvr", "package_url": "https://pypi.org/project/hyvr/", "platform": "", "project_url": "https://pypi.org/project/hyvr/", "project_urls": { "Homepage": "https://github.com/driftingtides/hyvr" }, "release_url": "https://pypi.org/project/hyvr/1.1.0/", "requires_dist": null, "requires_python": ">=3.4", "summary": "A python package for simulating hydrogeological virtual realities", "version": "1.1.0", "yanked": false, "yanked_reason": null }, "last_serial": 6481449, "releases": { "0.1": [ { "comment_text": "", "digests": { "md5": "bc58a8430c209d44723df5e86f140d2a", "sha256": "2251655e84bfdf64a69cb3337cf1034299b06005a2776a2928a12b3c44c08c4d" }, "downloads": -1, "filename": "hyvr-0.1-py3-none-any.whl", "has_sig": false, "md5_digest": "bc58a8430c209d44723df5e86f140d2a", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 36233, "upload_time": "2018-02-02T19:55:19", "upload_time_iso_8601": "2018-02-02T19:55:19.985494Z", "url": "https://files.pythonhosted.org/packages/f2/58/2e3e70581a14764ecbf0981773fa256d7401d6e639a053731b74c3e257a4/hyvr-0.1-py3-none-any.whl", "yanked": false, "yanked_reason": null }, { "comment_text": "", "digests": { "md5": "2d4133320fa52d78f1efe80f3042fc54", "sha256": "8863898aeaa53d142ee252cce7d3407dccc37eb9643c7749cc43e3979aa8cdec" }, "downloads": -1, "filename": "hyvr-0.1.zip", "has_sig": false, "md5_digest": "2d4133320fa52d78f1efe80f3042fc54", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 43436, "upload_time": "2018-02-02T19:55:22", "upload_time_iso_8601": "2018-02-02T19:55:22.609710Z", "url": "https://files.pythonhosted.org/packages/56/d3/fc7aed5435fd603017e5668a9e3b483be09e74f0d4d9da332db4d3bfa16d/hyvr-0.1.zip", "yanked": false, "yanked_reason": null } ], "0.2": [ { "comment_text": "", "digests": { "md5": "91ba0aace74b39489a86a6c8b3cbab23", "sha256": "dcfae573697e0114ce4764a61ac7712cedef6d7c9272696644d62a3b68bdcd6f" }, "downloads": -1, "filename": "hyvr-0.2.tar.gz", "has_sig": false, "md5_digest": "91ba0aace74b39489a86a6c8b3cbab23", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.4", "size": 103903, "upload_time": "2018-06-12T13:24:12", "upload_time_iso_8601": "2018-06-12T13:24:12.875573Z", "url": "https://files.pythonhosted.org/packages/26/2d/4d5716f757e5bdf3913e975660b03faa5f0145562eb64df71e22aa646193/hyvr-0.2.tar.gz", "yanked": false, "yanked_reason": null } ], "0.2.2": [ { "comment_text": "", "digests": { "md5": "e2ac402d6eda89b07be8b47bbfe4a64d", "sha256": "c9f85fd80412f7b9a35c6d48a9ff28e2f4dff990131be71a4b1337a288651c55" }, "downloads": -1, "filename": "hyvr-0.2.2-cp35-cp35m-win_amd64.whl", "has_sig": false, "md5_digest": "e2ac402d6eda89b07be8b47bbfe4a64d", "packagetype": "bdist_wheel", "python_version": "cp35", "requires_python": ">=3.4", "size": 73963, "upload_time": "2018-06-13T14:33:22", "upload_time_iso_8601": "2018-06-13T14:33:22.245309Z", "url": "https://files.pythonhosted.org/packages/a6/59/864b1a08c1b50a4e4f576aa47fa9d75c24bcd8390310c4bc5690687d0be6/hyvr-0.2.2-cp35-cp35m-win_amd64.whl", "yanked": false, "yanked_reason": null }, { "comment_text": "", "digests": { "md5": "9010253814a73a9f8dc95bf443cc9990", "sha256": "aa0dd3713c98f75c8631e5e2cc91d581cb2cb6f8d06cc953a8b5e355ba2ce0b2" }, "downloads": -1, "filename": "hyvr-0.2.2.tar.gz", "has_sig": false, "md5_digest": "9010253814a73a9f8dc95bf443cc9990", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.4", "size": 108366, "upload_time": "2018-06-12T17:07:11", "upload_time_iso_8601": "2018-06-12T17:07:11.030161Z", "url": "https://files.pythonhosted.org/packages/f9/df/9120daaf9ae5f709b04a7819317995d964cc428cc8d6d49e85e44bb7ad9f/hyvr-0.2.2.tar.gz", "yanked": false, "yanked_reason": null } ], "0.2.3": [ { "comment_text": "", "digests": { "md5": "a89e140d9747aa265f92fb5281ca8f04", "sha256": "14d3ac2017e20fbf248868666b8dd78ec292c0acb51ebc8b6c1be6fe0d076acb" }, "downloads": -1, "filename": "hyvr-0.2.3-cp35-cp35m-win_amd64.whl", "has_sig": false, "md5_digest": "a89e140d9747aa265f92fb5281ca8f04", "packagetype": "bdist_wheel", "python_version": "cp35", "requires_python": ">=3.4", "size": 72855, "upload_time": "2018-07-19T19:35:25", "upload_time_iso_8601": "2018-07-19T19:35:25.743220Z", "url": "https://files.pythonhosted.org/packages/8c/d7/143e014360f01bc064f35e068d1d914d8d19e3241f307e33c3f12c39b268/hyvr-0.2.3-cp35-cp35m-win_amd64.whl", "yanked": false, "yanked_reason": null }, { "comment_text": "", "digests": { "md5": "8b3adb49921edbde3071044774065fa9", "sha256": "0d78b3b68f7511ba82182b679d1aa6da11097a006d97de54a1ff21f549b00825" }, "downloads": -1, "filename": "hyvr-0.2.3.tar.gz", "has_sig": false, "md5_digest": "8b3adb49921edbde3071044774065fa9", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.4", "size": 109204, "upload_time": "2018-07-19T16:40:04", "upload_time_iso_8601": "2018-07-19T16:40:04.211991Z", "url": "https://files.pythonhosted.org/packages/7e/17/9eb7d6c79e4b2b9ceca325393a822e65be9c8c3da714edd0985a7a2c292c/hyvr-0.2.3.tar.gz", "yanked": false, "yanked_reason": null } ], "1.0.0": [ { "comment_text": "", "digests": { "md5": "491950ef83b91fc3dd86f6bd817a8e73", "sha256": "cce152a43fb174e89bc7b93cb1579b760ca135ff0036a0a4c5583ab7d6adaba1" }, "downloads": -1, "filename": "hyvr-1.0.0.tar.gz", "has_sig": false, "md5_digest": "491950ef83b91fc3dd86f6bd817a8e73", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.4", "size": 976677, "upload_time": "2018-12-06T18:40:43", "upload_time_iso_8601": "2018-12-06T18:40:43.337039Z", "url": "https://files.pythonhosted.org/packages/1b/6a/5064c7fc432607d8f4f858d334faf7e4f14cd7e55d29cce3035232824a28/hyvr-1.0.0.tar.gz", "yanked": false, "yanked_reason": null } ], "1.0.1": [ { "comment_text": "", "digests": { "md5": "4c2c76c282ed7f8c2ef860f3d97be3ba", "sha256": "ae38ee8b6c1ca989abedadee922d47400b82163b2b2d2827187b176f72fee5cb" }, "downloads": -1, "filename": "hyvr-1.0.1.tar.gz", "has_sig": false, "md5_digest": "4c2c76c282ed7f8c2ef860f3d97be3ba", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.4", "size": 978522, "upload_time": "2019-10-20T17:26:06", "upload_time_iso_8601": "2019-10-20T17:26:06.065512Z", "url": "https://files.pythonhosted.org/packages/3c/fe/01ef6b798018131f3feac1a85f686b698390f41983086d4a245e1cdcf423/hyvr-1.0.1.tar.gz", "yanked": false, "yanked_reason": null } ], "1.0.2": [ { "comment_text": "", "digests": { "md5": "e5c1ee3dacb606c93e92dd87008e0883", "sha256": "e1b15a6900023f03f1e1f1143ac80646db54a6d00c02d6cef6e974ee9f077afc" }, "downloads": -1, "filename": "hyvr-1.0.2.0-cp37-cp37m-win_amd64.whl", "has_sig": false, "md5_digest": "e5c1ee3dacb606c93e92dd87008e0883", "packagetype": "bdist_wheel", "python_version": "cp37", "requires_python": ">=3.4", "size": 704231, "upload_time": "2019-10-26T19:45:25", "upload_time_iso_8601": "2019-10-26T19:45:25.341754Z", "url": "https://files.pythonhosted.org/packages/cd/42/e4b51fc8c8df83e7022ae0bb8e1908e3760ce15aad41e4e518ac123ece29/hyvr-1.0.2.0-cp37-cp37m-win_amd64.whl", "yanked": false, "yanked_reason": null }, { "comment_text": "", "digests": { "md5": "a6ef9c32254d19c890451da2bce6cfb3", "sha256": "42a2d0fbab823d5500924dbeb74e605e6e9761330ac2338af5f28fb3353f17a0" }, "downloads": -1, "filename": "hyvr-1.0.2.0.tar.gz", "has_sig": false, "md5_digest": "a6ef9c32254d19c890451da2bce6cfb3", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.4", "size": 983872, "upload_time": "2019-10-26T19:45:35", "upload_time_iso_8601": "2019-10-26T19:45:35.548089Z", "url": "https://files.pythonhosted.org/packages/61/d3/eddf51f66c4d1c3c2ea25deb72b8917aebb63a27e0ae0552d18019700cc0/hyvr-1.0.2.0.tar.gz", "yanked": false, "yanked_reason": null }, { "comment_text": "", "digests": { "md5": "6dd5684f81235fb5df8a7e90e23bf64f", "sha256": "fecb33c3041a508f77528242a2e21256caa600230a1e7f624d433efb6f5194e9" }, "downloads": -1, "filename": "hyvr-1.0.2-cp37-cp37m-win_amd64.whl", "has_sig": false, "md5_digest": "6dd5684f81235fb5df8a7e90e23bf64f", "packagetype": "bdist_wheel", "python_version": "cp37", "requires_python": ">=3.4", "size": 704245, "upload_time": "2019-10-26T19:45:17", "upload_time_iso_8601": "2019-10-26T19:45:17.448258Z", "url": "https://files.pythonhosted.org/packages/45/1e/81ffc0af47abe8588ce419be42a117ad4c0de74e50c58c45012b7d5de91d/hyvr-1.0.2-cp37-cp37m-win_amd64.whl", "yanked": false, "yanked_reason": null } ], "1.0.3": [ { "comment_text": "", "digests": { "md5": "1b14936c4340fbaf91edffd9a1534b8b", "sha256": "3218c1f45005a2bb13c54fb70c6a687a011e9bfd7c6523cd1bf573cbe3984b5e" }, "downloads": -1, "filename": "hyvr-1.0.3-cp37-cp37m-win_amd64.whl", "has_sig": false, "md5_digest": "1b14936c4340fbaf91edffd9a1534b8b", "packagetype": "bdist_wheel", "python_version": "cp37", "requires_python": ">=3.4", "size": 704245, "upload_time": "2019-10-26T19:48:50", "upload_time_iso_8601": "2019-10-26T19:48:50.801968Z", "url": "https://files.pythonhosted.org/packages/52/1f/f7b67b60992bd16f49586573b55603a399306f66378303757a032f688676/hyvr-1.0.3-cp37-cp37m-win_amd64.whl", "yanked": false, "yanked_reason": null }, { "comment_text": "", "digests": { "md5": "a7073567ced00663bcdd35bb4b9c6181", "sha256": "277d55e1bd8ea6aeb43af3e51cf286bf3cb946ad1a83be316dd21aaf7698b3c3" }, "downloads": -1, "filename": "hyvr-1.0.3.tar.gz", "has_sig": false, "md5_digest": "a7073567ced00663bcdd35bb4b9c6181", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.4", "size": 983920, "upload_time": "2019-10-26T19:49:00", "upload_time_iso_8601": "2019-10-26T19:49:00.839778Z", "url": "https://files.pythonhosted.org/packages/23/ae/af37b8171e41ec759ca21053c2b8e45bbb4dd74aab5b25edb35aee05081a/hyvr-1.0.3.tar.gz", "yanked": false, "yanked_reason": null } ], "1.1.0": [ { "comment_text": "", "digests": { "md5": "b50b68576f24a96a23f85908d57384c4", "sha256": "9d1eb6c7ef2f3cb52c63d81670546b005cef04f58e6b237f35056d8aea4f752e" }, "downloads": -1, "filename": "hyvr-1.1.0.tar.gz", "has_sig": false, "md5_digest": "b50b68576f24a96a23f85908d57384c4", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.4", "size": 1536164, "upload_time": "2020-01-19T09:57:32", "upload_time_iso_8601": "2020-01-19T09:57:32.455270Z", "url": "https://files.pythonhosted.org/packages/da/6c/f1f85ce33389188a924e157907d1747917c489a629995ed1e008926f927b/hyvr-1.1.0.tar.gz", "yanked": false, "yanked_reason": null } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "b50b68576f24a96a23f85908d57384c4", "sha256": "9d1eb6c7ef2f3cb52c63d81670546b005cef04f58e6b237f35056d8aea4f752e" }, "downloads": -1, "filename": "hyvr-1.1.0.tar.gz", "has_sig": false, "md5_digest": "b50b68576f24a96a23f85908d57384c4", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.4", "size": 1536164, "upload_time": "2020-01-19T09:57:32", "upload_time_iso_8601": "2020-01-19T09:57:32.455270Z", "url": "https://files.pythonhosted.org/packages/da/6c/f1f85ce33389188a924e157907d1747917c489a629995ed1e008926f927b/hyvr-1.1.0.tar.gz", "yanked": false, "yanked_reason": null } ], "vulnerabilities": [] }