Skip to content

Commit ef2a247

Browse files
committed
docs: add installation notes for pygraphviz and Graphviz dependencies
1 parent 4031b42 commit ef2a247

1 file changed

Lines changed: 43 additions & 0 deletions

File tree

docs/getting-started/installation.mdx

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -68,6 +68,49 @@ uv add "graflow[all]"
6868

6969
You can also install individual extras, e.g. `graflow[visualization]` or `graflow[tracing]`.
7070

71+
:::note[pygraphviz requires system-level Graphviz]
72+
73+
`graflow[visualization]` (and `graflow[all]`) depends on **pygraphviz**, which requires the Graphviz C libraries to be installed on your system **before** running `pip install`. Without them, the build will fail with an error like:
74+
75+
```
76+
× Building wheel for pygraphviz (pyproject.toml) did not run successfully.
77+
│ exit code: 1
78+
╰─> See above for output.
79+
80+
note: This error originates from a subprocess, and is likely not a problem with pip.
81+
Building wheel for pygraphviz (pyproject.toml) ... error
82+
ERROR: Failed building wheel for pygraphviz
83+
ERROR: ERROR: Failed to build installable wheels for some pyproject.toml based projects (pygraphviz)
84+
```
85+
86+
Install Graphviz first using your system package manager:
87+
88+
<Tabs>
89+
<TabItem value="mac" label="macOS" default>
90+
91+
```bash
92+
brew install graphviz
93+
```
94+
95+
Depending on your environment, you may also need to set the following environment variables so that pygraphviz can find the Graphviz headers and libraries:
96+
97+
```bash
98+
export CFLAGS="-I$(brew --prefix graphviz)/include"
99+
export LDFLAGS="-L$(brew --prefix graphviz)/lib"
100+
```
101+
102+
</TabItem>
103+
<TabItem value="debian" label="Debian / Ubuntu">
104+
105+
```bash
106+
sudo apt install -y --no-install-recommends graphviz graphviz-dev
107+
```
108+
109+
</TabItem>
110+
</Tabs>
111+
112+
:::
113+
71114
## Verify Installation
72115

73116
After installation, verify that Graflow is installed correctly:

0 commit comments

Comments
 (0)