Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ricklupton/ipysankeywidget
IPython / Jupyter Sankey diagram widget
https://github.com/ricklupton/ipysankeywidget
Last synced: 19 days ago
JSON representation
IPython / Jupyter Sankey diagram widget
- Host: GitHub
- URL: https://github.com/ricklupton/ipysankeywidget
- Owner: ricklupton
- License: mit
- Created: 2016-03-05T14:43:10.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2023-03-15T09:13:43.000Z (over 1 year ago)
- Last Synced: 2024-11-15T14:13:16.480Z (27 days ago)
- Language: JavaScript
- Size: 2.28 MB
- Stars: 175
- Watchers: 5
- Forks: 24
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome-starred - ricklupton/ipysankeywidget - IPython / Jupyter Sankey diagram widget (others)
README
# IPython Sankey diagram widget [![Binder](https://mybinder.org/badge.svg)](https://mybinder.org/v2/gh/ricklupton/ipysankeywidget/master?urlpath=lab/tree/examples/Simple%20example.ipynb) [![Conda Version](https://img.shields.io/conda/vn/conda-forge/ipysankeywidget.svg)](https://anaconda.org/conda-forge/ipysankeywidget)
Display Sankey diagrams in IPython / Jupyter notebook using [d3-sankey-diagram](https://github.com/ricklupton/d3-sankey-diagram).
## Installation
To install use pip:
$ pip install ipysankeywidget
Alternatively, to install using conda:$ conda install -c conda-forge ipysankeywidget
For a development install, see [DEVELOPING.md](DEVELOPING.md).
## Browser support
Tested in Firefox and Chrome. [There have been reports](https://github.com/ricklupton/ipysankeywidget/issues/2) that it's not working in Safari.
## DocumentationSee the
[d3-sankey-diagram API docs](https://github.com/ricklupton/d3-sankey-diagram/wiki):
the attributes of the `SankeyWidget` are the same as the properties of the `sankey` object described there.To change the figure size, use the ipywidgets Layout object:
```python
layout = Layout(width="1000", height="1200")
SankeyWidget(links=data, layout=layout)
```## Examples
See notebooks in examples folder for usage examples. You can try these online
using[Binder](https://mybinder.org/v2/gh/ricklupton/ipysankeywidget/master?urlpath=lab/tree/examples/Simple%20example.ipynb),
or follow the links to static versions on nbviewer:
- [Simple example](http://nbviewer.jupyter.org/github/ricklupton/ipysankeywidget/blob/master/examples/Simple%20example.ipynb)
- [Advanced examples](http://nbviewer.jupyter.org/github/ricklupton/ipysankeywidget/blob/master/examples/More%20examples.ipynb)
- [Linking and Layout](http://nbviewer.jupyter.org/github/ricklupton/ipysankeywidget/blob/master/examples/Linking%20and%20Layout.ipynb)
- [Exporting Images](http://nbviewer.jupyter.org/github/ricklupton/ipysankeywidget/blob/master/examples/Exporting%20Images.ipynb)## Changelog
### v0.5.0 (16 December 2022)
- Compatible with Jupyter Lab as well as Jupyter notebook.
### v0.4.2 (29 April 2022)
- Expose d3-sankey-diagram nodePositions() option to allow for custom node layout.
### v0.4.1 (18 February 2021)
- Experimental support for link "markers"
- Experimental support for showing HTML info for links### v0.4.0 (19 November 2020)
- Update to d3-sankey-diagram v0.8.0
### v0.3.0
- Now supports Jupyterlab
### v0.2.5
- You can now show link values as SVG text elements. Set `linkLabelFormat` to a [d3-format string](https://github.com/d3/d3-format#locale_format); links whose value is more than `linkLabelMinWidth` will have a label using that format.
- Upgrade to d3-sankey-diagram version 0.7.3
- ipysankeywidget can now be installed using conda (thanks to Ali Alsabbah #33)
- Add a check for duplicate links (thanks to Remi Bois #23)### v0.2.4
- Add events for clicking on nodes and links: `on_node_clicked` and
`on_link_clicked`. These replace the `on_selected` event.## Contributors
- Rick Lupton
- Nicholas Bollweg
- Ali Alsabbah
- Remi Bois
- Miguel Mendez