Reactive transport model through MODFLOW 6 and PHREEQCRM
Project description
# MF6RTM: Reactive Transport Model via the MODFLOW 6 and PHREEQCRM APIs ![Tests](https://github.com/p-ortega/mf6rtm/actions/workflows/tests_main.yml/badge.svg) ![Tests](https://github.com/p-ortega/mf6rtm/actions/workflows/tests_macos.yml/badge.svg)
[![GitHub tag](https://img.shields.io/github/tag/mf6rtm/mf6rtm.svg)](https://github.com/p-ortega/mf6rtm/releases/tag/latest) [![PyPI License](https://img.shields.io/pypi/l/mf6rtm)](https://pypi.python.org/pypi/mf6rtm) <!– [![PyPI Status](https://img.shields.io/pypi/status/modflowapi.png)](https://pypi.python.org/pypi/mf6rtm) –> <!– [![PyPI Format](https://img.shields.io/pypi/format/modflowapi)](https://pypi.python.org/pypi/mf6rtm) –> [![PyPI Version](https://img.shields.io/pypi/v/mf6rtm.png)](https://pypi.python.org/pypi/mf6rtm) [![PyPI Versions](https://img.shields.io/pypi/pyversions/mf6rtm.png)](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)
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file mf6rtm-0.1.1.tar.gz
.
File metadata
- Download URL: mf6rtm-0.1.1.tar.gz
- Upload date:
- Size: 20.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.1.1 CPython/3.10.14
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0e3d3afb0409763f5242e7ee3404003805c46d58a04d468699e2f8c61dd6eead |
|
MD5 | df701406450a2d42c990257eb7aef8a7 |
|
BLAKE2b-256 | abc6ef673510ee5c57fbcfae58e6e93600f6ad1d02204c940257b35094d86bdb |
File details
Details for the file mf6rtm-0.1.1-py3-none-any.whl
.
File metadata
- Download URL: mf6rtm-0.1.1-py3-none-any.whl
- Upload date:
- Size: 20.0 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.1.1 CPython/3.10.14
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 17106d0da115788efb5fd90ecedfa331ba872fe1b2fd3423e7ed0a3fb8cd2e40 |
|
MD5 | c0408b7fd53dbb9e23e8c30967ac78f0 |
|
BLAKE2b-256 | 6bb443554d694c0368e1da0f9ffaa2bb3d5546450fc9abcb91d2c0d3261bd8ef |