diff --git a/README.rst b/README.rst index 5a76cfb..06b264d 100644 --- a/README.rst +++ b/README.rst @@ -67,14 +67,34 @@ To install floWeaver locally, you need Python 3 installed (you might want to ins using `Anaconda or Miniconda `_); see the `installation page `_ for full details. -Install floweaver using pip: +Installation using conda +________________________ + +You can install floweaver using conda: + +.. code-block:: console + + conda install -c conda-forge floweaver + +You likely also want `ipysankeywidget `_ to show Sankey +diagrams in the Jupyter notebook. Install it using conda: + +.. code-block:: console + + conda install -c conda-forge ipysankeywidget + +(that's it — the jupyter nbextensions are enabled automatically when using conda) + +Installation using pip +______________________ + +Alternatively, you can install floweaver using pip: .. code-block:: console pip install floweaver -You likely also want the `ipywidgets `_ -and `ipysankeywidget `_ packages to show Sankey +You likely also want `ipysankeywidget `_ to show Sankey diagrams in the Jupyter notebook. Install this using pip and enable: .. code-block:: console @@ -89,6 +109,9 @@ common cause of problems so it doesn't hurt to do it again! jupyter nbextension enable --py --sys-prefix widgetsnbextension +Quickstart tutorial +___________________ + To get started, open the `quickstart tutorial `_ in Jupyter notebook and step through the notebook cells to produce the fruit example shown above.