6
6
Welcome to sankeyview's documentation!
7
7
=======================================
8
8
9
- .. toctree ::
10
- :maxdepth: 2
11
- :hidden:
12
-
13
- introduction
14
- introduction/Introductory example
15
- jupyter
16
- api
17
-
18
-
19
9
.. image :: sankeyview_overview.png
20
10
21
11
Sankeyview generates Sankey diagrams from a dataset of flows. For a descriptive
@@ -24,45 +14,37 @@ multidimensional data for understanding resource use
24
14
<https://doi.org/10.1016/j.resconrec.2017.05.002> `_. For a more hands-on
25
15
introduction, read on.
26
16
27
- Installation
28
- ============
29
-
30
- Install sankeyview using pip:
31
-
32
- .. code-block :: shell
33
-
34
- $ pip install sankeyview
17
+ Getting started
18
+ ---------------
35
19
36
- If you use Jupyter notebooks -- a good way to get started -- you will also want
37
- to install `ipysankeywidget <https://github.com/ricklupton/ipysankeywidget >`_,
38
- an IPython widget to interactively display Sankey diagrams::
20
+ Start by installing sankeyview:
39
21
40
- $ pip install ipysankeywidget
41
- $ jupyter nbextension enable --py --sys-prefix ipysankeywidget
22
+ .. toctree ::
42
23
43
- .. note ::
24
+ installation
44
25
45
- If this is the first time you have installed IPython widgets, you also need to
46
- make sure they are enabled: :
26
+ Then the tutorials introduce the concepts used to generate and manipulate Sankey
27
+ diagrams :
47
28
48
- $ jupyter nbextension enable --py --sys-prefix widgetsnbextension
29
+ .. toctree ::
49
30
50
- If you use multiple virtualenvs or conda environments, make sure
51
- ``ipywidgets `` and ``ipysankeywidget `` are installed and enabled in both the
52
- environment running the notebook server and the kernel.
31
+ tutorials/Quickstart
32
+ tutorials/Showing fewer flows
53
33
54
- Getting started
55
- ===============
34
+ Documentation
35
+ -------------
56
36
57
- Start with the :ref: `introduction `, which introduces the concepts used to
58
- generate and manipulate Sankey diagrams.
37
+ The easiest way to use sankeyview is through the interactive
38
+ :ref: `Jupyter-interface `. The API pages describe the objects that describe the
39
+ diagrams.
59
40
60
- The easiest way to use sankeyview is through the interactive :ref: ` Jupyter-interface `.
41
+ .. toctree ::
61
42
62
- Alternatively, for more control you can use the :ref: `full-api `.
43
+ jupyter
44
+ api
63
45
64
46
Citing sankeyview
65
- =================
47
+ -----------------
66
48
67
49
If sankeyview has been significant in a project that leads to a publication,
68
50
please acknowledge that by citing `the paper linked above
@@ -75,7 +57,7 @@ please acknowledge that by citing `the paper linked above
75
57
76
58
77
59
Indices and tables
78
- ==================
60
+ ------------------
79
61
80
62
* :ref: `genindex `
81
63
* :ref: `modindex `
0 commit comments