Installation

AFQ-Insight requires Python >= 3.7.

Installing the release version

The recommended way to install AFQ-Insight is from PyPI,

$ pip install afqinsight

This will install AFQ-Insight and all of its dependencies.

Installing the development version

The development version is less stable but may include new features. You can install the development version using pip:

pip install git+https://github.com/tractometry/AFQ-Insight.git

Alternatively, you can clone the source code from the github repository:

$ git clone git@github.com:tractometry/AFQ-Insight.git
$ cd AFQ-Insight
$ pip install .

If you would like to contribute to AFQ-Insight, see the contributing guidelines.

Next, go to the user guide or see the example gallery for further information on how to use AFQ-Insight.

Installing on M1 / M2 Macs

Due to the complexity of installing support of HDF5 on newer macs, we recommend using the following steps to install AFQ-Insight on M1 / M2 Macs and relying on the homebrew package manager to install the required dependencies.

$ pip install cython
$ brew install hdf5
$ brew install c-blosc
$ export HDF5_DIR=/opt/homebrew/opt/hdf5
$ export BLOSC_DIR=/opt/homebrew/opt/c-blosc
$ pip install tables

If that does not work, another alternative is to install these dependencies using conda:

$ conda install h5py
$ conda install tables

If you encounter any issues, please let us know by opening an issue on the github repository.