# MF6RTM: Reactive Transport Model via the MODFLOW 6 and PHREEQCRM APIs
<!-- [](https://github.com/p-ortega/mf6rtm/releases/tag/latest) -->
[](https://pypi.python.org/pypi/mf6rtm)
<!-- [](https://pypi.python.org/pypi/mf6rtm) -->
<!-- [](https://pypi.python.org/pypi/mf6rtm) -->
[](https://pypi.python.org/pypi/mf6rtm)
[](https://pypi.python.org/pypi/mf6rtm)
## Benchmarks
Benchmark comparing model results against PHT3D are in `benchmark/`. Each folder contains a Jupyter notebook to write and execute an MF6RTM model via the MUP3D class. Additionally, PHT3D files are provided in the corresponding `pht3d` directory for each example.
## Considerations
The current version is intended to work with structured grids (dis object in MF6) and one MF6 simulation that includes the flow and transport solutions. No support is currently provided for a 'flow then transport scheme,' meaning that advanced packages cannot be incorporated yet.
On the PHREEQC side, the following have been included:
- Solution
- Equilibrium phases
- Cation Exchange
- Surface Complexation
- Kinetic Phases
Most options for each phreeqc block can be passed by adding list with options. However, not all options had been tested, so please create an issue if any option is not working or crashing the model.
## Software requirements
All dependencies and executables are included in this repo. This package extensively uses [modflowapi](https://github.com/MODFLOW-USGS/modflowapi) and [phreeqcrm](https://github.com/usgs-coupled/phreeqcrm)
## Installation
The package is still not published in PyPi but it can be installed through pip by cloning the repository.
Once the repository is already cloned in your local machine, please just type the following in your conda prompt:
```commandline
conda env create -f env.yml
```
Otherwise, the package can be installed through pip as:
```commandline
pip install git+https://github.com/p-ortega/mf6rtm.git#egg=mf6rtm
```
## Funding
The developing of mf6rtm was kindly funded and supported by [Intera, Inc](https://www.intera.com).
## Authors
Pablo Ortega (Portega)
Raw data
{
"_id": null,
"home_page": null,
"name": "mf6rtm",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "MODFLOW, PHREEQCRM, reactive transport, groundwater, hydrology",
"author": "Pablo Ortega",
"author_email": "portega@intera.com",
"download_url": "https://files.pythonhosted.org/packages/42/05/7474f97a7ce6b776de6c0ddf1e85b50a392f07d51ac4f82d3393d8941f71/mf6rtm-0.1.4.tar.gz",
"platform": "unix",
"description": "# MF6RTM: Reactive Transport Model via the MODFLOW 6 and PHREEQCRM APIs\r\n\r\n\r\n\r\n<!-- [](https://github.com/p-ortega/mf6rtm/releases/tag/latest) -->\r\n[](https://pypi.python.org/pypi/mf6rtm)\r\n<!-- [](https://pypi.python.org/pypi/mf6rtm) -->\r\n<!-- [](https://pypi.python.org/pypi/mf6rtm) -->\r\n[](https://pypi.python.org/pypi/mf6rtm)\r\n[](https://pypi.python.org/pypi/mf6rtm)\r\n\r\n## Benchmarks\r\nBenchmark comparing model results against PHT3D are in `benchmark/`. Each folder contains a Jupyter notebook to write and execute an MF6RTM model via the MUP3D class. Additionally, PHT3D files are provided in the corresponding `pht3d` directory for each example.\r\n\r\n## Considerations\r\nThe current version is intended to work with structured grids (dis object in MF6) and one MF6 simulation that includes the flow and transport solutions. No support is currently provided for a 'flow then transport scheme,' meaning that advanced packages cannot be incorporated yet.\r\n\r\nOn the PHREEQC side, the following have been included:\r\n\r\n- Solution\r\n- Equilibrium phases\r\n- Cation Exchange\r\n- Surface Complexation\r\n- Kinetic Phases\r\n\r\nMost options for each phreeqc block can be passed by adding list with options. However, not all options had been tested, so please create an issue if any option is not working or crashing the model.\r\n\r\n## Software requirements\r\nAll dependencies and executables are included in this repo. This package extensively uses [modflowapi](https://github.com/MODFLOW-USGS/modflowapi) and [phreeqcrm](https://github.com/usgs-coupled/phreeqcrm)\r\n\r\n## Installation\r\nThe package is still not published in PyPi but it can be installed through pip by cloning the repository. \r\n\r\nOnce the repository is already cloned in your local machine, please just type the following in your conda prompt:\r\n\r\n```commandline\r\nconda env create -f env.yml\r\n```\r\n\r\nOtherwise, the package can be installed through pip as:\r\n\r\n```commandline\r\npip install git+https://github.com/p-ortega/mf6rtm.git#egg=mf6rtm\r\n```\r\n\r\n## Funding\r\nThe developing of mf6rtm was kindly funded and supported by [Intera, Inc](https://www.intera.com).\r\n\r\n## Authors\r\nPablo Ortega (Portega)\r\n",
"bugtrack_url": null,
"license": "BSD 3-Clause",
"summary": "Reactive transport model through MODFLOW 6 and PHREEQCRM",
"version": "0.1.4",
"project_urls": null,
"split_keywords": [
"modflow",
" phreeqcrm",
" reactive transport",
" groundwater",
" hydrology"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "e3112888d7c89bab010c4588fbf6eabc34a4f7e68109dccbc122a504973007ed",
"md5": "d1dca4283bb7ad39fce448fbfabff7f7",
"sha256": "3c6666dfb9c40436bac3c4027b644997d532aaf141167015f25a84bb01d15a88"
},
"downloads": -1,
"filename": "mf6rtm-0.1.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "d1dca4283bb7ad39fce448fbfabff7f7",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 107455,
"upload_time": "2024-08-13T07:03:50",
"upload_time_iso_8601": "2024-08-13T07:03:50.392607Z",
"url": "https://files.pythonhosted.org/packages/e3/11/2888d7c89bab010c4588fbf6eabc34a4f7e68109dccbc122a504973007ed/mf6rtm-0.1.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "42057474f97a7ce6b776de6c0ddf1e85b50a392f07d51ac4f82d3393d8941f71",
"md5": "e91e0d058963ee955f7552878fffd229",
"sha256": "2d6042ade057d3424039c3d6c4ad10e5fbe283c56211921b88dc02b87bf2241c"
},
"downloads": -1,
"filename": "mf6rtm-0.1.4.tar.gz",
"has_sig": false,
"md5_digest": "e91e0d058963ee955f7552878fffd229",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 110937,
"upload_time": "2024-08-13T07:03:54",
"upload_time_iso_8601": "2024-08-13T07:03:54.362498Z",
"url": "https://files.pythonhosted.org/packages/42/05/7474f97a7ce6b776de6c0ddf1e85b50a392f07d51ac4f82d3393d8941f71/mf6rtm-0.1.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-13 07:03:54",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "mf6rtm"
}
JSON