Welcome to PetroBuffer’s documentation!

PetroBuffer is a Python package which performs redox and buffer conversions common in geochemistry.

The current implementation has been developed in Python 3 and tested on Windows.

Installation/Usage:

petrobuffer is available on PyPi, and can be downloaded with pip:

pip install petrobuffer

Note

petrobuffer is not yet packaged for Anaconda, and as such conda install petrobuffer will not work.

Alternatively, to access the most up-to-date development version, you can clone the package from github into the same root directory as your project files where you wish to use PetroBuffer.

The package can then be pip installed by running

pip install PetroBuffer/

from your project root, and imported in your files in the same way as other packages, using

import petrobuffer

Warning

Note that breaking changes occur can occur when importing a package this way, and it is not guaranteed to remain stable.

For usage examples, see Examples.

Limitations

• PetroBuffer currently only supports a small number of functions. The aim is to expand this package over time.

Acknowledgements

The testing of this package made heavy use of the excellent Excel tools from Kayla Iacovino: an fO2 buffer calculator and a Ferric/Ferrous converter.

Contents:

• Models in PetroBuffer
  • Buffer Models
  • Ferric/Ferrous <-> fO2 interconversions
• Examples
  • Convert from one f O2 buffer to another
• PetroBuffer’s Code Documentation
  • petrobuffer.buffers
  • petrobuffer.conversions
  • petrobuffer.core
  • petrobuffer.ferric

Indices and tables

• Index

• Module Index

• Search Page