Skip to main content

Reactive transport model through MODFLOW 6 and PHREEQCRM

Project description

MF6RTM: Reactive Transport Model via the MODFLOW 6 and PHREEQCRM APIs

Tests Tests Coverage Status PyPI License

PyPI Version PyPI Versions DOI

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), unstructured grids (disv) 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 and phreeqcrm

Installation

The package can be installed through pip as:

pip install mf6rtm

Developing

We recommend forking and cloning a local version of this repo. A development Conda environment is provided in the env.yml file, which should install all required dependencies to run tests and modify the package on the fly. To install the environment, use the following command:

conda env create -f env.yml

Funding

The developing of mf6rtm was kindly funded and supported by Intera, Inc.

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

mf6rtm-0.2.1.tar.gz (57.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

mf6rtm-0.2.1-py3-none-any.whl (62.1 kB view details)

Uploaded Python 3

File details

Details for the file mf6rtm-0.2.1.tar.gz.

File metadata

  • Download URL: mf6rtm-0.2.1.tar.gz
  • Upload date:
  • Size: 57.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.2.0 CPython/3.14.0

File hashes

Hashes for mf6rtm-0.2.1.tar.gz
Algorithm Hash digest
SHA256 f881515b2725bb1c4aaa3f5f48070889706d997a1301187e19570d2a8fb1e8b4
MD5 e69ec222584c5b8455b60bb1a9a28f62
BLAKE2b-256 aedf46f0e264e97d9366eebb6a0074ddb400c2e03c4d88eb6a5cb453375ab88e

See more details on using hashes here.

File details

Details for the file mf6rtm-0.2.1-py3-none-any.whl.

File metadata

  • Download URL: mf6rtm-0.2.1-py3-none-any.whl
  • Upload date:
  • Size: 62.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.2.0 CPython/3.14.0

File hashes

Hashes for mf6rtm-0.2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 ad6c426fdb016c64b53f0682860aa24a48dc59f787188a4e30fa47b814471ba6
MD5 b6fac02e2cbda0367e91b37c048756ae
BLAKE2b-256 2e2864345766221737340b02bd065451c663f5fbbd73929f2c21056ca4f1d471

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page