Skip to main content

Estimate thermodynamic properties of aqueous metal complexes with monovalent ligands.

Project description

The Complicator

Code Authors: Grayson Boyer, Everett Shock Data Compilers: GEOPIG Lab, Apar Prasad

This is a Python package for estimating standard state thermodynamic properties and Helgeson-Kirkham-Flowers (HKF) equation of state parameters for aqueous metal complexes with monovalent ligands using published methods from Sverjensky et al. (1997) and Shock et al. (1997)

Installation

This package can be installed through PyPI with: pip install Complicator

Usage

The best way to learn about the Complicator is through the WORM Portal (worm-portal.asu.edu). Check out Jupyter notebook demo 4-2-1 in the WORM Library that is available when you log in.

What follows is a brief example of how the Complicator can be used.

Supply a dataframe containing names of metals, ligands, stability constants for the first through fourth association at 25 °C, and optionally, standard state entropies of association for the first through fourth association complex. An example is assigned to the variable df_input in the example below.

import pandas as pd
from Complicator import complicate

df_input = pd.DataFrame({
        "Metal":["Ag+", "Al+3"],
        "Ligand":["OH-", "OH-"],
        "BETA_1":[2, 9.03], # stability constant for the first association complex
        "BETA_2":[3.97, 17.6], # second stability constant
        "BETA_3":[float('NaN'), 26.4], # third stability constant
        "BETA_4":[float('NaN'), 33.8], # fourth stability constant
        "Sass_1":[float('NaN'), 36.5], # entropy of association for the first complex (cal/mol/K)
        })

df_out, _, _, _ = complicate(df_in=df_input)

df_out

The output is a dataframe containing estimated thermodynamic properties, parameters for the revised Helgeson Kirkham Flowers (HKF) equation of state, and more. The format of the output is explained in more detail here. This Water-Organic-Rock-Microbe (WORM) database format is designed to be compatible with the free and open source online geochemical modeling platform WORM Portal. Estimated thermodynamic properties of complexes from the Complicator can be used in conjunction with the rest of the WORM database to:

  • calculate properties of reactions and create activity or predominance diagrams.
  • expand the number of aqueous complexes available in geochemical speciation (equilibration) and mass transfer calculations.

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

complicator-0.3.0.tar.gz (174.0 kB view details)

Uploaded Source

Built Distribution

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

complicator-0.3.0-py3-none-any.whl (147.9 kB view details)

Uploaded Python 3

File details

Details for the file complicator-0.3.0.tar.gz.

File metadata

  • Download URL: complicator-0.3.0.tar.gz
  • Upload date:
  • Size: 174.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.3

File hashes

Hashes for complicator-0.3.0.tar.gz
Algorithm Hash digest
SHA256 2caa58b2716415376ab14745a40316c4529ebc5f248fb13b7877aa54bc47cbbe
MD5 eac5018e0c4c03abb468adfbf5c46279
BLAKE2b-256 84bccc8ef63c7ef559420afb6c9e848a077275256915f52653edaf2ef306f1c8

See more details on using hashes here.

File details

Details for the file complicator-0.3.0-py3-none-any.whl.

File metadata

  • Download URL: complicator-0.3.0-py3-none-any.whl
  • Upload date:
  • Size: 147.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.3

File hashes

Hashes for complicator-0.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 e4fe34051a7574f39d0561fbfb577ef12d33f8162de7f12210ac3c10f27bcfbc
MD5 65c0c7f8d02c34e8133b36ad7a4d7368
BLAKE2b-256 8b538d6ab047fb5a873d6ea139be604d59166379c2dbcc0c5d292a926dda30dd

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