sankeydata

Data structure for Sankey diagrams.


Keywords
Sankey, diagram, flow, data, format, JSON
License
MIT
Install
pip install sankeydata==0.1.dev0

Documentation

sankeydata

This repo is part of the floWeaver project, aiming to define a common data format for storing and exchanging Sankey diagram data. It aims to cover both the logical structure (without exact coordinates and geometry) and the detailed layout of a diagram.

There are two parts to this repo:

  1. A JSON schema document, formally describing the file format.

  2. A Python package sankeydata providing Python data structures and serialisation to the JSON format.

Contributing

Contributions are welcome: we want to make sure this format is useful to a range of users and compatible with different tools. For now, see the roadmap and contribution guide in the floWeaver repository.