Installation

Required Dependencies

  • Python (3.8 or later)

  • numpy (1.19 or later)

  • scipy (1.6 or later)

  • pandas (1.5 or later)

Optional Dependencies

  • pyfluids (2.6 or later) For use in Brine Models

  • matplotlib - For plotting and visualization

Installing via pip

Pyrrhenius is designed to be used within a pip or Anaconda-managed Python environment.

To install the latest stable release of Pyrrhenius from PyPI, use the following command within bash or zshell after activating your preferred pyrrhenius environment:

pip install pyrrhenius

Installing via git

pip can also be used to install the latest development branch of pyrrhenius, provided git is also installed

pip install git+git://github.com/k-a-mendoza/pyrrhenius@master

Installing pyfluids

For brine modeling, Pyrrhenius can use the pyfluids package. To install this optional dependency, use the following command:

pip install pyfluids

Testing

To run the test suite after installing pytest, follow these steps:

  1. Install pytest either via pip or conda:

    pip install pytest
    

    or

    conda install pytest
    
  2. Navigate to the root directory of the Pyrrhenius repository.

  3. Run pytest:

    pytest