Installation & Updating

Installation

First, obtain Python3 (tested on V3.9). If you haven’t used python before, we recomend installing it through anaconda.

anaconda3.

RelaxiFI can be installed using pip in one line. If you are using a terminal, enter:

pip install RelaxiFI

If you are using Jupyter Notebooks or Jupyter Lab, you can also install it by entering the following code into a notebook cell (note the !):

!pip install RelaxiFI

You then need to import RelaxiFI into the script you are running code in. In all the examples, we import RelaxiFI as relax.:

import RelaxiFI as relax

This means any time you want to call a function from RelaxiFI, you do relax.function_name.

NOTE: Coolprop (http://www.coolprop.org/) available at PyPI (https://pypi.org/project/CoolProp/) is REQUIRED to perform calculations using the EOS of Span and Wagner (1996) in this package. Make sure to install it using pip install CoolProp or !pip install CoolProp (if from a jupyter notebook)

Updating

To upgrade to the most recent version of RelaxiFI, type the following into terminal:

pip install RelaxiFI --upgrade

Or in your Jupyter environment:

!pip install RelaxiFI --upgrade

For maximum reproducability, you should state which version of RelaxiFI you are using. If you have imported RelaxiFI as relax, you can find this using:

relax.__version__