The easiest way to install ipfx is via pip:

pip install ipfx

We suggest installing ipfx into a managed Python environment, such as those provided by anaconda or venv. This avoids conflicts between different Python and package versions.

Installing for development

If you wish to make contributions to ipfx (thank you!), you must clone the git repository. You will need to install git-lfs before cloning (we store some test data in lfs). Once you have cloned ipfx, simply pip install it into your environment:

pip install -e path/to/your/ipfx/clone

(-e installs in editable mode, so that you can use your changes right off the bat).

See Contributing to the IPFX for more information.