Installation#

Install the Conda environment#

You may skip this step if your Conda environment has been installed already.

Step 1: Download the installation script for miniconda3#

macOS (Intel)#

wget https://repo.anaconda.com/miniconda/Miniconda3-latest-MacOSX-x86_64.sh

macOS (Apple Silicon)#

wget https://repo.anaconda.com/miniconda/Miniconda3-latest-MacOSX-arm64.sh

Linux#

wget https://repo.anaconda.com/miniconda/Miniconda3-latest-Linux-x86_64.sh

Step 2: Install Miniconda3#

chmod +x Miniconda3-latest-*.sh && ./Miniconda3-latest-*.sh

During the installation, a path <base-path> needs to be specified as the base location of the python environment. After the installation is done, we need to add the two lines into your shell environment (e.g., ~/.bashrc or ~/.zshrc) as below to enable the conda package manager (remember to change <base-path> with your real location):

export PATH="<base-path>/bin:$PATH"
. <base-path>/etc/profile.d/conda.sh

Step 3: Test your Installation#

source ~/.bashrc  # assume you are using Bash shell
which python  # should return a path under <base-path>
which conda  # should return a path under <base-path>

Install cfr#

Taking a clean installation as example, first let’s create a new environment named cfr-env via conda

conda create -n cfr-env python=3.11
conda activate cfr-env

Then install some dependencies via conda:

conda install jupyter notebook cartopy statsmodels pykdtree

Once the above dependencies have been installed, simply

pip install cfr

and you are ready to

import cfr

in Python.

If you’d like to also enable the usage of the Proxy System Models, which requires some extra dependencies, simply

pip install "cfr[psm]"

and, you are ready to

from cfr import psm