.. image:: docs/_static/logo.png
:alt: floWeaver
:align: center
:width: 697
:height: 222
:target: https://github.com/ricklupton/floweaver
|
.. image:: https://badge.fury.io/py/floweaver.svg
:target: https://badge.fury.io/py/floweaver
:alt: PyPI Status
.. image:: https://readthedocs.org/projects/floweaver/badge/?version=latest
:target: http://floweaver.readthedocs.io/en/latest/?badge=latest
:alt: Documentation Status
.. image:: https://travis-ci.org/ricklupton/floweaver.svg?branch=master
:target: https://travis-ci.org/ricklupton/floweaver
:alt: Test Status
.. image:: https://codecov.io/gh/ricklupton/floweaver/branch/master/graph/badge.svg
:target: https://codecov.io/gh/ricklupton/floweaver
:alt: Coverage Status
.. image:: https://zenodo.org/badge/DOI/10.5281/zenodo.161970.svg
:target: https://doi.org/10.5281/zenodo.596249
:alt: DOI
by `Rick Lupton <http://www.ricklupton.name>`_ and `Contributors`_
Many kinds of data can be thought of as 'flows': energy and materials moving
through industry, money flowing through the economy, telephone lines moving
between providers, voters moving between parties. **floWeaver** helps you to
exchange and analyse flow data and visualise it using `Sankey diagrams
<https://en.wikipedia.org/wiki/Sankey_diagram>`_.
For example, here is some data on flows of fruit from farms to customers:
.. image:: docs/demo_table.png
With floWeaver you can **visualise** this as a variety of **Sankey diagrams**
depending on what you want to show:
.. image:: docs/demo_animation/demo.gif
Although there are a variety of tools for working with flow data and Sankey
diagrams in particular contexts, there are no open data formats for sharing data
between tools and domains. We aim to provide a **common data format and data converters**
to support interoperability and open data.
You are free to copy, modify, and distribute floWeaver with attribution
under the terms of the MIT license. See the `LICENSE <LICENSE>`_ file
for details. If you find it useful please acknowledge that by citing floWeaver
(`see below <#citing-floweaver>`_).
Get started using floWeaver
---------------------------
floWeaver is a Python package, but you can successfully use it as a data analysis
tool even without too much familiarity with Python. The best way to get started is
to use it in a `Jupyter notebook <http://jupyter.org/>`_ (more advanced users can
use it outside the notebook environment to export JSON/SVG but this is still
under development; see `this comment
<https://github.com/ricklupton/floweaver/issues/34#issuecomment-385040059>`_).
🚀 **Try floWeaver online with no installation:** `Quickstart tutorial on Binder
<https://mybinder.org/v2/gh/ricklupton/floweaver/master?filepath=docs%2Ftutorials%2Fquickstart.ipynb>`_.
To install floWeaver locally, you need Python 3 installed (you might want to install it
using `Anaconda or Miniconda <https://www.continuum.io/downloads>`_); see the `installation page
<https://floweaver.readthedocs.io/en/latest/installation.html>`_ for full details.
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 `ipysankeywidget <https://github.com/ricklupton/ipysankeywidget>`_ to show Sankey
diagrams in the Jupyter notebook. Install this using pip and enable:
.. code-block:: console
pip install ipysankeywidget
jupyter nbextension enable --py --sys-prefix ipysankeywidget
ipywidgets also needs to be enabled. You might have already done this, but missing it out is a
common cause of problems so it doesn't hurt to do it again!
.. code-block:: console
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.
Find out more 📖
________________
`Tutorials, cookbook examples, and API documentation are all available on ReadTheDocs
<https://floweaver.readthedocs.io/en/latest/>`_
If you have a question that isn't answered please `open an issue on GitHub
<https://github.com/ricklupton/floweaver/issues>`_, if there isn't one there already. You can
also use the `Gitter chatroom <https://gitter.im/floweaver/Lobby>`_ for discussion and questions.
Contributing 🎁
---------------
Thanks for your interest in contributing! There are many ways to contribute to floWeaver:
sharing examples of work done using it, suggestions for improving the documentation, examples
of things that are more difficult than they should be or don't work, as well as actual fixes to
code and documentation. To get started see `CONTRIBUTING.md <CONTRIBUTING.md>`_ and our `code of
conduct <CODE_OF_CONDUCT.md>`_.
We have a `detailed Roadmap <https://github.com/ricklupton/floweaver/projects/2>`_ showing what we
are working on up to May 2018; beyond that there is the `longer-term Roadmap <https://github.com/ricklupton/floweaver/projects/1>`_. We also have `good first issues grouped by type of contribution <https://github.com/ricklupton/floweaver/projects/3>`_.
How does it work?
-----------------
floWeaver builds on the approach described in the paper `Hybrid Sankey diagrams:
Visual analysis of multidimensional data for understanding resource use
<https://doi.org/10.1016/j.resconrec.2017.05.002>`_. It uses `ipysankeywidget
<https://github.com/ricklupton/ipysankeywidget>`_ and `d3-sankey-diagram
<https://github.com/ricklupton/d3-sankey-diagram>`_ for actually drawing the Sankey
diagrams.
.. image:: docs/project_components.png
Citing floWeaver
----------------
If floweaver has been significant in a project that leads to a publication, please
acknowledge that by citing the paper linked above:
R. C. Lupton and J. M. Allwood, ‘Hybrid Sankey diagrams: Visual analysis of multidimensional
data for understanding resource use’, Resources, Conservation and Recycling, vol. 124, pp.
141–151, Sep. 2017. DOI: 10.1016/j.resconrec.2017.05.002
and/or citing the software itself; you can `get a citation of the latest version from Zenodo
<https://doi.org/10.5281/zenodo.596249>`_.
Contributors
------------
- Leo Paoli (documentation)
- Konstantin Stadler (issues & use in IOA)
- Dhanuka Lakshan
- Andreas Fehlner
- Elliott Sales de Andrade
- @abmakko (the logo)
- Chris Barnes (@clbarnes)
Raw data
{
"_id": null,
"home_page": "https://github.com/ricklupton/floweaver",
"name": "floweaver",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.5",
"maintainer_email": "",
"keywords": "Sankey diagram flow data visualisation",
"author": "Rick Lupton",
"author_email": "mail@ricklupton.name",
"download_url": "https://files.pythonhosted.org/packages/82/a6/8c9f318e853b6902df579532c73875408de78c30013436cc05ca0f967e7c/floweaver-2.0.1.tar.gz",
"platform": null,
"description": ".. image:: docs/_static/logo.png\n :alt: floWeaver\n :align: center\n :width: 697\n :height: 222\n :target: https://github.com/ricklupton/floweaver\n\n|\n\n.. image:: https://badge.fury.io/py/floweaver.svg\n :target: https://badge.fury.io/py/floweaver\n :alt: PyPI Status\n.. image:: https://readthedocs.org/projects/floweaver/badge/?version=latest\n :target: http://floweaver.readthedocs.io/en/latest/?badge=latest\n :alt: Documentation Status\n.. image:: https://travis-ci.org/ricklupton/floweaver.svg?branch=master\n :target: https://travis-ci.org/ricklupton/floweaver\n :alt: Test Status\n.. image:: https://codecov.io/gh/ricklupton/floweaver/branch/master/graph/badge.svg\n :target: https://codecov.io/gh/ricklupton/floweaver\n :alt: Coverage Status\n.. image:: https://zenodo.org/badge/DOI/10.5281/zenodo.161970.svg\n :target: https://doi.org/10.5281/zenodo.596249\n :alt: DOI\n\nby `Rick Lupton <http://www.ricklupton.name>`_ and `Contributors`_\n \nMany kinds of data can be thought of as 'flows': energy and materials moving\nthrough industry, money flowing through the economy, telephone lines moving\nbetween providers, voters moving between parties. **floWeaver** helps you to\nexchange and analyse flow data and visualise it using `Sankey diagrams\n<https://en.wikipedia.org/wiki/Sankey_diagram>`_.\n\nFor example, here is some data on flows of fruit from farms to customers:\n\n.. image:: docs/demo_table.png\n\nWith floWeaver you can **visualise** this as a variety of **Sankey diagrams**\ndepending on what you want to show:\n\n.. image:: docs/demo_animation/demo.gif\n\nAlthough there are a variety of tools for working with flow data and Sankey\ndiagrams in particular contexts, there are no open data formats for sharing data\nbetween tools and domains. We aim to provide a **common data format and data converters** \nto support interoperability and open data.\n\nYou are free to copy, modify, and distribute floWeaver with attribution\nunder the terms of the MIT license. See the `LICENSE <LICENSE>`_ file\nfor details. If you find it useful please acknowledge that by citing floWeaver \n(`see below <#citing-floweaver>`_).\n\nGet started using floWeaver\n---------------------------\n\nfloWeaver is a Python package, but you can successfully use it as a data analysis\ntool even without too much familiarity with Python. The best way to get started is\nto use it in a `Jupyter notebook <http://jupyter.org/>`_ (more advanced users can\nuse it outside the notebook environment to export JSON/SVG but this is still\nunder development; see `this comment\n<https://github.com/ricklupton/floweaver/issues/34#issuecomment-385040059>`_).\n\n\ud83d\ude80 **Try floWeaver online with no installation:** `Quickstart tutorial on Binder\n<https://mybinder.org/v2/gh/ricklupton/floweaver/master?filepath=docs%2Ftutorials%2Fquickstart.ipynb>`_.\n\nTo install floWeaver locally, you need Python 3 installed (you might want to install it \nusing `Anaconda or Miniconda <https://www.continuum.io/downloads>`_); see the `installation page\n<https://floweaver.readthedocs.io/en/latest/installation.html>`_ for full details.\n\nInstallation using conda\n________________________\n\nYou can install floweaver using conda:\n\n.. code-block:: console\n\n conda install -c conda-forge floweaver\n\nYou likely also want `ipysankeywidget <https://github.com/ricklupton/ipysankeywidget>`_ to show Sankey\ndiagrams in the Jupyter notebook. Install it using conda:\n\n.. code-block:: console\n\n conda install -c conda-forge ipysankeywidget\n \n(that's it \u2014 the jupyter nbextensions are enabled automatically when using conda)\n \nInstallation using pip\n______________________\n\nAlternatively, you can install floweaver using pip:\n\n.. code-block:: console\n\n pip install floweaver\n\nYou likely also want `ipysankeywidget <https://github.com/ricklupton/ipysankeywidget>`_ to show Sankey\ndiagrams in the Jupyter notebook. Install this using pip and enable:\n\n.. code-block:: console\n\n pip install ipysankeywidget\n jupyter nbextension enable --py --sys-prefix ipysankeywidget\n \nipywidgets also needs to be enabled. You might have already done this, but missing it out is a\ncommon cause of problems so it doesn't hurt to do it again!\n\n.. code-block:: console\n\n jupyter nbextension enable --py --sys-prefix widgetsnbextension\n\nQuickstart tutorial\n___________________\n\nTo get started, open the `quickstart tutorial <docs/tutorials/quickstart.ipynb>`_ in\nJupyter notebook and step through the notebook cells to produce the fruit example shown above.\n\nFind out more \ud83d\udcd6\n________________\n\n`Tutorials, cookbook examples, and API documentation are all available on ReadTheDocs\n<https://floweaver.readthedocs.io/en/latest/>`_\n\nIf you have a question that isn't answered please `open an issue on GitHub\n<https://github.com/ricklupton/floweaver/issues>`_, if there isn't one there already. You can\nalso use the `Gitter chatroom <https://gitter.im/floweaver/Lobby>`_ for discussion and questions.\n\nContributing \ud83c\udf81\n---------------\n\nThanks for your interest in contributing! There are many ways to contribute to floWeaver: \nsharing examples of work done using it, suggestions for improving the documentation, examples\nof things that are more difficult than they should be or don't work, as well as actual fixes to\ncode and documentation. To get started see `CONTRIBUTING.md <CONTRIBUTING.md>`_ and our `code of\nconduct <CODE_OF_CONDUCT.md>`_.\n\nWe have a `detailed Roadmap <https://github.com/ricklupton/floweaver/projects/2>`_ showing what we\nare working on up to May 2018; beyond that there is the `longer-term Roadmap <https://github.com/ricklupton/floweaver/projects/1>`_. We also have `good first issues grouped by type of contribution <https://github.com/ricklupton/floweaver/projects/3>`_.\n\nHow does it work?\n-----------------\n\nfloWeaver builds on the approach described in the paper `Hybrid Sankey diagrams:\nVisual analysis of multidimensional data for understanding resource use\n<https://doi.org/10.1016/j.resconrec.2017.05.002>`_. It uses `ipysankeywidget \n<https://github.com/ricklupton/ipysankeywidget>`_ and `d3-sankey-diagram \n<https://github.com/ricklupton/d3-sankey-diagram>`_ for actually drawing the Sankey\ndiagrams.\n\n.. image:: docs/project_components.png\n\nCiting floWeaver\n----------------\n\nIf floweaver has been significant in a project that leads to a publication, please\nacknowledge that by citing the paper linked above:\n\n R. C. Lupton and J. M. Allwood, \u2018Hybrid Sankey diagrams: Visual analysis of multidimensional\n data for understanding resource use\u2019, Resources, Conservation and Recycling, vol. 124, pp.\n 141\u2013151, Sep. 2017. DOI: 10.1016/j.resconrec.2017.05.002\n\nand/or citing the software itself; you can `get a citation of the latest version from Zenodo \n<https://doi.org/10.5281/zenodo.596249>`_.\n\nContributors\n------------\n\n- Leo Paoli (documentation)\n- Konstantin Stadler (issues & use in IOA)\n- Dhanuka Lakshan\n- Andreas Fehlner\n- Elliott Sales de Andrade\n- @abmakko (the logo)\n- Chris Barnes (@clbarnes)\n\n\n",
"bugtrack_url": null,
"license": "",
"summary": "View flow data as Sankey diagrams.",
"version": "2.0.1",
"split_keywords": [
"sankey",
"diagram",
"flow",
"data",
"visualisation"
],
"urls": [
{
"comment_text": "",
"digests": {
"md5": "dbe84df1fc9568840531729bb811d9fc",
"sha256": "3252df9fc628f86b4d39d6d346e87d432378fa2ca7b36c37fc10cef837fd263f"
},
"downloads": -1,
"filename": "floweaver-2.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "dbe84df1fc9568840531729bb811d9fc",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.5",
"size": 28501,
"upload_time": "2022-12-19T08:46:54",
"upload_time_iso_8601": "2022-12-19T08:46:54.382637Z",
"url": "https://files.pythonhosted.org/packages/64/ae/aeb75d5484ead8012673c0487c6790e8fd19039c1db56184e3c2c567e656/floweaver-2.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"md5": "032603900f372d676f189c0848eb2882",
"sha256": "f2f7bb67af1a20137bbb05f95187d7f9be9c106b37e71650b71d6be0ac6276a3"
},
"downloads": -1,
"filename": "floweaver-2.0.1.tar.gz",
"has_sig": false,
"md5_digest": "032603900f372d676f189c0848eb2882",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.5",
"size": 38186,
"upload_time": "2022-12-19T08:46:56",
"upload_time_iso_8601": "2022-12-19T08:46:56.286001Z",
"url": "https://files.pythonhosted.org/packages/82/a6/8c9f318e853b6902df579532c73875408de78c30013436cc05ca0f967e7c/floweaver-2.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2022-12-19 08:46:56",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "ricklupton",
"github_project": "floweaver",
"travis_ci": true,
"coveralls": true,
"github_actions": false,
"lcname": "floweaver"
}
JSON
