Merge 7207880 into 5560a50

holoviz · Jun 22, 2017 · 2cc54b2 · 2cc54b2
2 parents 5560a50 + 7207880
commit 2cc54b2
Show file tree

Hide file tree

Showing 77 changed files with 10,004 additions and 38 deletions.
diff --git a/doc/User_Guide/Annotating_Data.rst b/doc/User_Guide/Annotating_Data.rst
@@ -0,0 +1,2 @@
+Annotating your Data
+____________________
diff --git a/doc/User_Guide/Data_Pipelines.rst b/doc/User_Guide/Data_Pipelines.rst
@@ -0,0 +1,2 @@
+Data Transformation Pipelines
+_____________________________
diff --git a/doc/User_Guide/Dimensioned_Containers.rst b/doc/User_Guide/Dimensioned_Containers.rst
@@ -0,0 +1,2 @@
+Dimensioned Containers
+______________________
diff --git a/doc/User_Guide/IPython_Magics.rst b/doc/User_Guide/IPython_Magics.rst
@@ -0,0 +1,2 @@
+IPython Magics
+______________
diff --git a/doc/User_Guide/Plots_and_Renderers.rst b/doc/User_Guide/Plots_and_Renderers.rst
@@ -0,0 +1,2 @@
+Working with Plot and Renderers
+_______________________________
diff --git a/doc/User_Guide/Plotting_with_Matplotlib.rst b/doc/User_Guide/Plotting_with_Matplotlib.rst
@@ -0,0 +1,2 @@
+Plotting with Matplotlib
+________________________
diff --git a/doc/conf.py b/doc/conf.py
@@ -52,8 +52,8 @@
     ),
     # Links
     'LINKS': (
-        ('Getting started', 'Getting_Started/index.html'),
-        ('User Guides', 'User_Guide/index.html'),
+        ('Getting started', 'getting_started/index.html'),
+        ('User Guide', 'user_guide/index.html'),
         ('Tutorials', 'Tutorials/index.html'),
         ('Gallery', 'Gallery/index.html'),
         ('Reference', 'Reference_Manual/index.html'),
@@ -71,8 +71,8 @@
     ),
     # Links for the docs sub navigation
     'NAV_DOCS': (
-        ('Getting started', 'Getting_Started/index'),
-        ('User Guides', 'User_Guide/index'),
+        ('Getting started', 'getting_started/index'),
+        ('User Guide', 'user_guide/index'),
         ('Tutorials', 'Tutorials/index'),
         ('Gallery', 'gallery/index'),
         ('Reference', 'Reference_Manual/index'),

diff --git a/doc/getting_started/Customization.rst b/doc/getting_started/Customization.rst
@@ -0,0 +1,5 @@
+Customization
+_____________
+
+.. notebook:: holoviews ../../guides/getting_started/2-Customization.ipynb
+    :offset: 1
diff --git a/doc/getting_started/Gridded_Datasets.rst b/doc/getting_started/Gridded_Datasets.rst
@@ -0,0 +1,5 @@
+Gridded Datasets
+________________
+
+.. notebook:: holoviews ../../guides/getting_started/4-Gridded_Datasets.ipynb
+    :offset: 1
diff --git a/doc/getting_started/Introduction.rst b/doc/getting_started/Introduction.rst
@@ -0,0 +1,5 @@
+Introduction
+____________
+
+.. notebook:: holoviews ../../guides/getting_started/1-Introduction.ipynb
+    :offset: 1
diff --git a/doc/getting_started/Live_Data.rst b/doc/getting_started/Live_Data.rst
@@ -0,0 +1,6 @@
+Live Data
+_________
+
+.. notebook:: holoviews ../../guides/getting_started/5-Live_Data.ipynb
+    :skip_output: When run live, this cell's output should match the behavior of the GIF below
+    :offset: 1
diff --git a/doc/getting_started/Tabular_Datasets.rst b/doc/getting_started/Tabular_Datasets.rst
@@ -0,0 +1,5 @@
+Tabular Datasets
+________________
+
+.. notebook:: holoviews ../../guides/getting_started/3-Tabular_Datasets.ipynb
+    :offset: 1
diff --git a/doc/getting_started/index.rst b/doc/getting_started/index.rst
@@ -0,0 +1,21 @@
+Welcome to HoloViews!
+_____________________
+
+This 'Getting Started' guide aims to get you using HoloViews productively as quickly as possible. It is designed as an entrypoint for new users that will introduce the core concepts necessary to get you working productively with your own data. We recommend reading this guide in order if you wish to get an overview of what is offered by HoloViews. For detailed documentation, please consult our `User Guide <../user_guide/index.html>`_ which we will link to from the appropriate sections of this guide.
+
+* `Introduction <Introduction.html>`_
+* `Customization <Customization.html>`_
+* `Tabular Datasets <Tabular_Datasets.html>`_
+* `Gridded Datasets <Gridded_Datasets.html>`_
+* `Live Data <Live_Data>`_
+
+.. toctree::
+    :titlesonly:
+    :hidden:
+    :maxdepth: 2
+
+	Introduction <Introduction>
+	Customization <Customization>
+	Tabular Datasets <Tabular_Datasets>
+	Gridded Datasets <Gridded_Datasets>
+	Live Data <Live_Data>
diff --git a/doc/index.rst b/doc/index.rst
@@ -139,6 +139,8 @@ showing how to fix the bug or implement the feature!
    :maxdepth: 2
 
    Home <self>
+   Getting Started <getting_started/index>
+   User Guide <user_guide/index>
    Features <features>
    Tutorials <Tutorials/index>
    Examples <Examples/index>

diff --git a/doc/user_guide/Applying_Transformations.rst b/doc/user_guide/Applying_Transformations.rst
@@ -0,0 +1,5 @@
+Applying Transformations
+________________________
+
+.. notebook:: holoviews ../../guides/user_guide/Applying_Transformations.ipynb
+    :offset: 1
diff --git a/doc/user_guide/Building_Composite_Objects.rst b/doc/user_guide/Building_Composite_Objects.rst
@@ -0,0 +1,5 @@
+Building Composite Objects
+__________________________
+
+.. notebook:: holoviews ../../guides/user_guide/Building_Composite_Objects.ipynb
+    :offset: 1
diff --git a/doc/user_guide/Continuous_Coordinates.rst b/doc/user_guide/Continuous_Coordinates.rst
@@ -0,0 +1,5 @@
+Continuous Coordinates
+______________________
+
+.. notebook:: holoviews ../../guides/user_guide/Continuous_Coordinates.ipynb
+    :offset: 1
diff --git a/doc/user_guide/Custom_Interactivity.rst b/doc/user_guide/Custom_Interactivity.rst
@@ -0,0 +1,5 @@
+Custom Interactivity
+____________________
+
+.. notebook:: holoviews ../../guides/user_guide/Custom_Interactivity.ipynb
+    :offset: 1
diff --git a/doc/user_guide/Customizing_Plots.rst b/doc/user_guide/Customizing_Plots.rst
@@ -0,0 +1,5 @@
+Customizing Plots
+_________________
+
+.. notebook:: holoviews ../../guides/user_guide/Customizing_Plots.ipynb
+    :offset: 1
diff --git a/doc/user_guide/Deploying_Bokeh_Apps.rst b/doc/user_guide/Deploying_Bokeh_Apps.rst
@@ -0,0 +1,6 @@
+Deploying Bokeh Apps
+____________________
+
+.. notebook:: holoviews ../../guides/user_guide/Deploying_Bokeh_Apps.ipynb
+    :skip_execute: True
+    :offset: 1
diff --git a/doc/user_guide/Exporting_and_Archiving.rst b/doc/user_guide/Exporting_and_Archiving.rst
@@ -0,0 +1,5 @@
+Exporting and Archiving
+_______________________
+
+.. notebook:: holoviews ../../guides/user_guide/Exporting_and_Archiving.ipynb
+    :offset: 1
diff --git a/doc/user_guide/Gridded_Datasets.rst b/doc/user_guide/Gridded_Datasets.rst
@@ -0,0 +1,5 @@
+Gridded Datasets
+________________
+
+.. notebook:: holoviews ../../guides/user_guide/Gridded_Datasets.ipynb
+    :offset: 1
diff --git a/doc/user_guide/Indexing_and_Selecting_Data.rst b/doc/user_guide/Indexing_and_Selecting_Data.rst
@@ -0,0 +1,5 @@
+Indexing and Selecting Data
+___________________________
+
+.. notebook:: holoviews ../../guides/user_guide/Indexing_and_Selecting_Data.ipynb
+    :offset: 1
diff --git a/doc/user_guide/Large_Data.rst b/doc/user_guide/Large_Data.rst
@@ -0,0 +1,5 @@
+Working with large data using datashader
+________________________________________
+
+.. notebook:: holoviews ../../guides/user_guide/Large_Data.ipynb
+    :offset: 1
diff --git a/doc/user_guide/Live_Data.rst b/doc/user_guide/Live_Data.rst
@@ -0,0 +1,5 @@
+Live Data
+_________
+
+.. notebook:: holoviews ../../guides/user_guide/Live_Data.ipynb
+    :offset: 1
diff --git a/doc/user_guide/Plotting_with_Bokeh.rst b/doc/user_guide/Plotting_with_Bokeh.rst
@@ -0,0 +1,5 @@
+Plotting with Bokeh
+___________________
+
+.. notebook:: holoviews ../../guides/user_guide/Plotting_with_Bokeh.ipynb
+    :offset: 1
diff --git a/doc/user_guide/Responding_to_Events.rst b/doc/user_guide/Responding_to_Events.rst
@@ -0,0 +1,5 @@
+Responding to Events
+____________________
+
+.. notebook:: holoviews ../../guides/user_guide/Responding_to_Events.ipynb
+    :offset: 1
diff --git a/doc/user_guide/Tabular_Datasets.rst b/doc/user_guide/Tabular_Datasets.rst
@@ -0,0 +1,5 @@
+Tabular Datasets
+________________
+
+.. notebook:: holoviews ../../guides/user_guide/Tabular_Datasets.ipynb
+    :offset: 1
diff --git a/doc/user_guide/index.rst b/doc/user_guide/index.rst
@@ -0,0 +1,137 @@
+User Guide
+__________
+
+
+Core guides
+-----------
+
+These user guides provide detailed explanation of some of the core
+concepts in HoloViews:
+
+* `Annotating your Data <01-Annotating_Data.html>`_
+  How to wrap your data in Element and annotate it with additional
+  metadata to explore and visualize it effectively.
+
+* `Composition of Elements <02-Composing_Elements.html>`_
+  Composing your wrapped data into ``Overlay`` and ``Layout``
+  collections with the ``+`` and ``*`` operators.
+
+* `Customizing Plots <03-Customizing_Plots.html>`_
+  Applying plot, style and normalization options to control the look
+  and feel of the plotting.
+
+* `Dimensioned Containers <04-Dimensioned_Containers.html>`_
+  Declaring multi-dimensional containers to animate and facet your
+  data flexibly. Learn about ``HoloMap``, ``NdOverlay``, ``GridSpace``
+  and ``NdLayout`` types and how to use them effectively with the
+  corresponding ``.layout``, ``.overlay`` and ``.grid`` method.
+
+* `Building Composite Objects <05-Building_Composite_Objects.html>`_
+  How to build and work with complex composite objects.
+
+* `Live Data <06-Live_Data.html>`_
+  Introducing ``DynamicMap`` to lazily declare data and generate
+  complex interactive visualizations.
+
+* `Tabular Datasets <07-Tabular_Datasets.html>`_
+  Loading and wrapping tabular datasets in HoloViews using NumPy,
+  pandas and dask and flexibly exploring the dataset using selection,
+  grouping and aggregation.
+
+* `Gridded Datasets <08-Gridded_Datasets.html>`_
+  Loading and wrapping gridded dataset in HoloViews using NumPy and
+  XArray to flexibly explore and visualize labelled n-dimensional
+  arrays.
+
+* `Indexing and Selecting Data <09-Indexing_and_Selecting_Data.html>`_
+  Effectively indexing and selecting subsets of the data on the
+  different HoloViews datastructures.
+
+* `Transforming Elements <10-Transforming_Elements.html>`_
+  Applying and declaring ``Operations`` that transform your allowing
+  you to define the building blocks of a data analysis pipeline and
+  quickly explore and visualize the effect of different parameters on
+  your data.
+
+* `Responding to Events <11-Responding_to_Events.html>`_
+  Effectively using ``Streams`` to dynamically control and drive your
+  visualizations by responding to user defined events such as custom
+  widgets or from the commandline or notebook.
+
+* `Custom Interactivity <12-Custom_Interactivity.html>`_
+  Using linked ``Streams`` to respond to events generated by
+  interacting with a bokeh plot, e.g. by responding to mouse position,
+  mouse taps, selections or the current axis range.
+
+* `Data Transformation Pipelines <Data_Pipelines.html>`_
+  Chaining different operations to build complex and lazy data
+  analysis pipelines, which can drive interactive plots in a notebook
+  or in a deployed dashboard.
+
+* `Working with large data <14-Large_Data.html>`_
+  Leveraging datashader support in HoloViews to effectively and
+  interactively explore and visualize millions or even billions of
+  datapoints.
+
+
+Supplementary guides
+--------------------
+
+These guides provide detail about specific additional features in HoloViews:
+
+* `Plotting with Bokeh <Plotting_with_Bokeh.html>`_
+  The basics of plotting with bokeh including details about plot tools
+  and backend specific styling options and working with bokeh models
+  more directly.
+
+* `Deploying Bokeh Apps <Deploying_Bokeh_Apps.html>`_
+  Instructions on how to declare and deploy bokeh apps using HoloViews
+  in various scenarios, e.g. from scripts, from the commandline and
+  within the notebook.
+
+* `Plotting with matplotlib <Plotting_with_Matplotlib.html>`_
+  The basics of plotting with matplotlib highlighting core differences
+  in styling and controlling the layout of matplotlib figures.
+
+* `Plotting with plotly <Plotting_with_Plotly.html>`_
+  The basics of plotting with plotly focusing on 3D plotting, one of
+  the main strengths of plotly.
+
+* `Working with renderers and plots <Plots_and_Renderers.html>`_
+  Using HoloViews Renderer and Plot classes directly to access and
+  manipulate your visualizations directly.
+
+* `Exporting and Archiving <Exporting_and_Archiving.html>`_
+  Using HoloViews to archive both your data and visualization from the
+  notebook.
+
+* `Continuous Coordinates <Continuous_Coordinates.html>`_ Details on
+  how continuous coordinates are handled in HoloViews specifically
+  focusing on the difference between ``Image`` and other ``Raster`` types.
+
+
+.. toctree::
+    :titlesonly:
+    :hidden:
+    :maxdepth: 2
+
+	Annotating your Data <1-Annotating_Data>
+	Composition of Elements <2-Composing_Elements>
+	Customizing Plots <3-Customizing_Plots>
+	Dimensioned Containers <4-Dimensioned_Containers>
+	Building Composite Objects <5-Building_Composite_Objects>
+	Live Data <6-Live_Data>
+	Tabular Datasets <7-Tabular_Datasets>
+	Gridded Datasets <8-Gridded_Datasets>
+	Indexing and Selecting Data <9-Indexing_and_Selecting_Data>
+	Transforming Elements <10-Applying_Transformations>
+	Responding to Events <11-Responding_to_Events>
+	Custom Interactivity <12-Custom_Interactivity>
+	Working with large data <14-Large_Data>
+	Plotting with Bokeh <Plotting_with_Bokeh>
+	Deploying Bokeh Apps <Deploying_Bokeh_Apps>
+	Plotting with matplotlib <Plotting_with_Matplotlib>
+	Plotting with plotly <Plotting_with_Plotly>
+	Working with Plot and Renderers <Plots_and_Renderers>
+	Exporting and Archiving <Exporting_and_Archiving>
+	Continuous Coordinates <Continuous_Coordinates>
diff --git a/examples/demos/bokeh/square_limit.ipynb b/examples/demos/bokeh/square_limit.ipynb
@@ -76,13 +76,13 @@
     "    den = float(n + m)\n",
     "    t1 = Affine2D().scale(n / den, 1)\n",
     "    t2 = Affine2D().scale(m / den, 1).translate(n / den, 0)\n",
-    "    return T(spline1, t1) * T(spline2, t2)\n",
+    "    return combine(T(spline1, t1) * T(spline2, t2))\n",
     "\n",
     "def above(spline1, spline2, n=1, m=1):\n",
     "    den = float(n + m)\n",
     "    t1 = Affine2D().scale(1, n / den).translate(0, m / den)\n",
     "    t2 = Affine2D().scale(1, m / den)\n",
-    "    return T(spline1, t1) * T(spline2, t2)\n",
+    "    return combine(T(spline1, t1) * T(spline2, t2))\n",
     "\n",
     "def nonet(p, q, r, s, t, u, v, w, x):\n",
     "    return above(beside(p, beside(q, r), 1, 2),\n",

diff --git a/examples/demos/matplotlib/square_limit.ipynb b/examples/demos/matplotlib/square_limit.ipynb
@@ -74,13 +74,13 @@
     "    den = float(n + m)\n",
     "    t1 = Affine2D().scale(n / den, 1)\n",
     "    t2 = Affine2D().scale(m / den, 1).translate(n / den, 0)\n",
-    "    return T(spline1, t1) * T(spline2, t2)\n",
+    "    return combine(T(spline1, t1) * T(spline2, t2))\n",
     "\n",
     "def above(spline1, spline2, n=1, m=1):\n",
     "    den = float(n + m)\n",
     "    t1 = Affine2D().scale(1, n / den).translate(0, m / den)\n",
     "    t2 = Affine2D().scale(1, m / den)\n",
-    "    return T(spline1, t1) * T(spline2, t2)\n",
+    "    return combine(T(spline1, t1) * T(spline2, t2))\n",
     "\n",
     "def nonet(p, q, r, s, t, u, v, w, x):\n",
     "    return above(beside(p, beside(q, r), 1, 2),\n",
@@ -125,8 +125,8 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "%%opts Spline [xaxis=None yaxis=None aspect='equal' bgcolor='white']\n",
-    "%%output size=300\n",
+    "%%opts Spline [xaxis=None yaxis=None aspect='equal' bgcolor='white'] (linewidth=0.8)\n",
+    "%%output size=250\n",
     "\n",
     "fish = hv.Spline((spline, [1,4,4,4]*34)) # Cubic splines\n",
     "smallfish = flip(rot45(fish))\n",

diff --git a/examples/elements/assets/penguins.png b/examples/elements/assets/penguins.png
diff --git a/examples/elements/bokeh/Bounds.ipynb b/examples/elements/bokeh/Bounds.ipynb
@@ -42,7 +42,7 @@
    "outputs": [],
    "source": [
     "%%opts Bounds (color='orange' line_width=6)\n",
-    "penguins = hv.RGB.load_image('../../../doc/assets/penguins.png')\n",
+    "penguins = hv.RGB.load_image('../assets/penguins.png')\n",
     "penguins * hv.Bounds((-0.15, -0.4, 0.2, 0))"
    ]
   },

diff --git a/examples/elements/bokeh/Path.ipynb b/examples/elements/bokeh/Path.ipynb
@@ -74,7 +74,7 @@
     "\n",
     "adultR = [(0.25, 0.45), (0.35,0.35), (0.25, 0.25), (0.15, 0.35), (0.25, 0.45)]\n",
     "adultL = [(-0.3, 0.4), (-0.3, 0.3), (-0.2, 0.3), (-0.2, 0.4),(-0.3, 0.4)]\n",
-    "scene = hv.RGB.load_image('../../../doc/assets/penguins.png')\n",
+    "scene = hv.RGB.load_image('../assets/penguins.png')\n",
     "\n",
     "scene * hv.Path([adultL, adultR, baby]) * hv.Path([baby])"
    ]

diff --git a/examples/elements/bokeh/RGB.ipynb b/examples/elements/bokeh/RGB.ipynb
@@ -41,7 +41,7 @@
    },
    "outputs": [],
    "source": [
-    "hv.RGB.load_image('../../../doc/assets/penguins.png')"
+    "hv.RGB.load_image('../assets/penguins.png')"
    ]
   },
   {