Skip to content

Commit a14d652

Browse files
committed
making graphviz optional (closes #24)
1 parent 873944c commit a14d652

1 file changed

Lines changed: 26 additions & 19 deletions

File tree

README.md

Lines changed: 26 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -19,25 +19,6 @@ This Python package provides a collection of tools for:
1919
WfCommons is available on [PyPI](https://pypi.org/project/wfcommons).
2020
WfCommons requires Python3.6+ and has been tested on Linux and macOS.
2121

22-
### Requirements
23-
24-
#### Graphviz
25-
WfCommons uses _pygraphviz_ and thus needs the graphviz package installed (version 2.16 or later).
26-
You can install graphviz easily on Linux with your favorite package manager,
27-
for example for Debian-based distributions:
28-
```
29-
sudo apt-get install graphviz libgraphviz-dev
30-
```
31-
and for RedHat-based distributions:
32-
```
33-
sudo yum install python-devel graphviz-devel
34-
```
35-
36-
On macOS you can use `brew` package manager:
37-
```
38-
brew install graphviz
39-
```
40-
4122
### Installation using pip
4223

4324
While `pip` can be used to install WfCommons, we suggest the following
@@ -62,6 +43,32 @@ $ cd wfcommons
6243
$ pip install .
6344
```
6445

46+
### Optional Requirements
47+
48+
#### Graphviz
49+
WfCommons uses _pygraphviz_ for generating visualizations for the workflow task graph.
50+
If you want to enable this feature, you will have to install the
51+
[graphviz](https://www.graphviz.org/) package (version 2.16 or later).
52+
You can install graphviz easily on Linux with your favorite package manager,
53+
for example for Debian-based distributions:
54+
```
55+
sudo apt-get install graphviz libgraphviz-dev
56+
```
57+
and for RedHat-based distributions:
58+
```
59+
sudo yum install python-devel graphviz-devel
60+
```
61+
62+
On macOS you can use `brew` package manager:
63+
```
64+
brew install graphviz
65+
```
66+
67+
Then you can install pygraphviz by running:
68+
```
69+
python3 -m pip install pygraphviz
70+
```
71+
6572
## Get in Touch
6673

6774
The main channel to reach the WfCommons team is via the support email:

0 commit comments

Comments
 (0)