Installation

If graph visualization is not required then install via pip:

pip install ananke-causal

Alternatively, the package may be installed from gitlab by cloning and cd into the directory. Then, poetry can be used to install:

Install with graph visualization

If graphing support is required, it is necessary to install graphviz.

Non M1 Mac instructions

Ubuntu:

sudo apt install graphviz libgraphviz-dev pkg-config

Mac Homebrew:

brew install graphviz

Fedora:

sudo yum install graphviz

Once graphviz has been installed, then:

M1 Mac specific instructions

If on M1 see this issue. The fix is to run the following before installing:

brew install graphviz
python -m pip install \
    --global-option=build_ext \
    --global-option="-I$(brew --prefix graphviz)/include/" \
    --global-option="-L$(brew --prefix graphviz)/lib/" \
    pygraphviz

Install graphviz using the appropriate method for your OS

# Ubuntu

sudo apt install graphviz libgraphviz-dev pkg-config

# Mac

brew install graphviz

# Mac (M1)
## see https://github.com/pygraphviz/pygraphviz/issues/398

brew install graphviz
python -m pip install \
    --global-option=build_ext \
    --global-option="-I$(brew --prefix graphviz)/include/" \
    --global-option="-L$(brew --prefix graphviz)/lib/" \
    pygraphviz

# Fedora

sudo yum install graphviz

Install the latest release using pip.

pip3 install ananke-causal

For more details please see the gitlab, or the documentation for details on how to use Ananke.