Skip to main content

Python wrapper for Iphreeqc

Project description

# IPhreeqcPy [![CI](https://github.com/raviapatel/IPhreeqcPy/actions/workflows/CI.yml/badge.svg)](https://github.com/raviapatel/IPhreeqcPy/actions/workflows/CI.yml) [![Deployment](https://github.com/raviapatel/IPhreeqcPy/actions/workflows/python-publish.yml/badge.svg)](https://github.com/raviapatel/IPhreeqcPy/actions/workflows/python-publish.yml)

[IPhreeqcPy](https://github.com/raviapatel/IPhreeqcPy) provides a wrapper to communicate with [IPhreeqc](http://wwwbrr.cr.usgs.gov/projects/GWC_coupled/phreeqc/) in [python](https://www.python.org/). It is an alternative to [PhreeqPy](http://www.phreeqpy.com/) and is derived from PhreeqcPy. One of the drawback of PhreeqcPy was that it used pythonic names spaces for IPhreeqc function calls which made Phreeqpy function calls different from IPhreeqc and has IPhreeqc manual couldnot be referred to. Secondly it did not have automated compilation for IPhreeqc during installation. As PhreeqPy is an open source I took further liberty to address this issue and redistribute it as IPhreeqcPy to avoid conflicts with development of PhreeqPy. Moreover more Iphreeqc function calls are included in IPhrereqcPy e.g. function calls related to dump which can be of use while restarting simulations.

## Developer

Ravi A. Patel

## Contact me

email (personal): <ravee.a.patel@gmail.com>

## Citation

If you are using IPhreeqcPy for academic work please cite this manual and IPhreeqcPy repository in your publications. Below is the bibtex format for citing IPhreeqcPy

@manual{Patel2024, title = “IPhreeqcPy a python wrapper for IPhreeqc”, author = “Ravi Patel”, url = “https://github.com/raviapatel/IPhreeqcPy”, year = “2024 (accessed July 31, 2024)” }

## Hosted at

Source code is hosted on [GitHub](https://github.com/raviapatel/IPhreeqcPy)

## Installation

pip install IPhreeqcPy

for installation for source read the [documentation](https://iphreeqcpy.readthedocs.io/en/latest/)

## Detailed Documentation

For documentation visit <https://iphreeqcpy.readthedocs.io/en/latest>

## Issues

report issues on [Github](https://iphreeqcpy.readthedocs.io/en/latest) and I will try to answer/resolve them

## License and Terms of use

IPhreeqcPy is a free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation, version 3 of the License. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details. You should have received a copy of the GNU Lesser General Public License along with this program. If not, see <http://www.gnu.org/licenses/>.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distributions

IPhreeqcPy-2024.0.0-py3-none-win_amd64.whl (1.1 MB view hashes)

Uploaded Python 3 Windows x86-64

Supported by

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