Skip to content

Commit

Permalink
Update installation instructions in README
Browse files Browse the repository at this point in the history
Now floweaver has conda packages in conda-forge
  • Loading branch information
ricklupton committed May 21, 2019
1 parent 13f7d2f commit a0a8af9
Showing 1 changed file with 26 additions and 3 deletions.
29 changes: 26 additions & 3 deletions README.rst
Expand Up @@ -67,14 +67,34 @@ To install floWeaver locally, you need Python 3 installed (you might want to ins
using `Anaconda or Miniconda <https://www.continuum.io/downloads>`_); see the `installation page
<https://floweaver.readthedocs.io/en/latest/installation.html>`_ 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 <https://github.com/ricklupton/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 <http://ipywidgets.readthedocs.io/en/latest/user_install.html>`_
and `ipysankeywidget <https://github.com/ricklupton/ipysankeywidget>`_ packages to show Sankey
You likely also want `ipysankeywidget <https://github.com/ricklupton/ipysankeywidget>`_ to show Sankey
diagrams in the Jupyter notebook. Install this using pip and enable:

.. code-block:: console
Expand All @@ -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 <docs/tutorials/quickstart.ipynb>`_ in
Jupyter notebook and step through the notebook cells to produce the fruit example shown above.

Expand Down

0 comments on commit a0a8af9

Please sign in to comment.