Installation¶
See below for more detailed instructions for Linux, Windows and OS X. In brief: install floweaver using pip:
$ pip install floweaver
If you use Jupyter notebooks – a good way to get started – you will also want to install ipysankeywidget, an IPython widget to interactively display Sankey diagrams:
$ pip install ipysankeywidget
$ jupyter nbextension enable --py --sys-prefix ipysankeywidget
Note
If this is the first time you have installed IPython widgets, you also need to make sure they are enabled:
$ jupyter nbextension enable --py --sys-prefix widgetsnbextension
If you use multiple virtualenvs or conda environments, make sure
ipywidgets
and ipysankeywidget
are installed and enabled in both the
environment running the notebook server and the kernel.
Note
If you apply Floweaver in restricted environments (e.g., Jupyter is hosted
on university servers), use --user
instead of --sys-prefix
in the
above commands.
Pip needs the switch too: pip install --user floweaver ipysankeywidget
.
Install on Windows¶
Floweaver requries the latest version of Python to be installed. This can be done by installing the Anaconda platform from Link here .
The procedure described in section Installation should be performed in the Anaconda Prompt, which can be found among the installed programs.
To open Jupyter Notebook and begin to work on the Sankey. Write in the Anaconda Prompt the following
$ jupyter notebook
Install on macOS¶
Floweaver requries the latest version of Python to be installed. This can be done by installing the Anaconda platform from Link here .
The procedure described in section Installation should be performed in the Command Line
To open Jupyter Notebook and begin to work on the Sankey. Write in the Command Line the following
$ jupyter notebook
[not sure about this :D]