@@ -4,34 +4,6 @@ Installation
44WfCommons is available on `PyPI <https://pypi.org/project/wfcommons >`_.
55WfCommons requires Python3.6+ and has been tested on Linux and macOS.
66
7- Requirements
8- ------------
9-
10- Graphviz
11- ^^^^^^^^
12-
13- WfCommons uses `pygraphviz <https://pygraphviz.github.io/documentation/latest/install.html >`_
14- and thus needs the `graphviz <https://www.graphviz.org/ >`_ package installed (version 2.16
15- or later). You can install graphviz easily on Linux with your favorite package manager,
16- for example for Debian-based distributions:
17-
18- .. code-block :: bash
19-
20- $ sudo apt-get install graphviz libgraphviz-dev
21-
22- and for RedHat-based distributions:
23-
24- .. code-block :: bash
25-
26- $ sudo yum install python-devel graphviz-devel
27-
28- On macOS you can use the :code: `brew ` package manager:
29-
30- .. code-block :: bash
31-
32- $ brew install graphviz
33-
34-
357Installation using pip
368----------------------
379
@@ -55,3 +27,31 @@ repository: ::
5527 $ git clone https://github.com/wfcommons/wfcommons
5628 $ cd wfcommons
5729 $ pip install .
30+
31+ Optional Requirements
32+ ---------------------
33+
34+ Graphviz
35+ ^^^^^^^^
36+
37+ WfCommons uses `pygraphviz <https://pygraphviz.github.io/documentation/latest/install.html >`_
38+ for generating visualizations for the workflow task graph . If you want to enable this
39+ feature, you will have to install the `graphviz <https://www.graphviz.org/ >`_ package (version 2.16
40+ or later). You can install graphviz easily on Linux with your favorite package manager,
41+ for example for Debian-based distributions:
42+
43+ .. code-block :: bash
44+
45+ $ sudo apt-get install graphviz libgraphviz-dev
46+
47+ and for RedHat-based distributions:
48+
49+ .. code-block :: bash
50+
51+ $ sudo yum install python-devel graphviz-devel
52+
53+ On macOS you can use the :code: `brew ` package manager:
54+
55+ .. code-block :: bash
56+
57+ $ brew install graphviz
0 commit comments