Skip to content

Commit

Permalink
Structured user guide and added rst files for missing guides
Browse files Browse the repository at this point in the history
  • Loading branch information
philippjfr committed Jun 21, 2017
1 parent cb1185b commit 948d1f8
Show file tree
Hide file tree
Showing 7 changed files with 139 additions and 22 deletions.
2 changes: 2 additions & 0 deletions doc/User_Guide/Annotating_Data.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
Annotating your Data
____________________
2 changes: 2 additions & 0 deletions doc/User_Guide/Data_Pipelines.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
Data Transformation Pipelines
_____________________________
2 changes: 2 additions & 0 deletions doc/User_Guide/Dimensioned_Containers.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
Dimensioned Containers
______________________
2 changes: 2 additions & 0 deletions doc/User_Guide/IPython_Magics.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
IPython Magics
______________
2 changes: 2 additions & 0 deletions doc/User_Guide/Plots_and_Renderers.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
Working with Plot and Renderers
_______________________________
2 changes: 2 additions & 0 deletions doc/User_Guide/Plotting_with_Matplotlib.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
Plotting with Matplotlib
________________________
149 changes: 127 additions & 22 deletions doc/user_guide/index.rst
Original file line number Diff line number Diff line change
@@ -1,38 +1,143 @@
User Guide
__________

* `Applying Transformations <Applying_Transformations.html>`_
* `Building Composite Objects <Building_Composite_Objects.html>`_
* `Continuous Coordinates <Continuous_Coordinates.html>`_
* `Custom Interactivity <Custom_Interactivity.html>`_

Core guides
-----------

These user guides provide detailed explanation of some of the core
concepts in HoloViews:

* `Annotating your Data <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 <Composing_Elements.html>`_
Composing your wrapped data into ``Overlay`` and ``Layout``
collections with the ``+`` and ``*`` operators.

* `Customizing Plots <Customizing_Plots.html>`_
* `Deploying Bokeh Apps <Deploying_Bokeh_Apps.html>`_
* `Exporting and Archiving <Exporting_and_Archiving.html>`_
Applying plot, style and normalization options to control the look
and feel of the plotting.

* `Dimensioned Containers <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 <Building_Composite_Objects.html>`_
How to build and work with complex composite objects.

* `Live Data <Live_Data.html>`_
Introducing ``DynamicMap`` to lazily declare data and generate
complex interactive visualizations.

* `Tabular Datasets <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 <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 <Indexing_and_Selecting_Data.html>`_
* `Live Data <Live_Data.html>`_
* `Plotting with Bokeh <Plotting_with_Bokeh.html>`_
Effectively indexing and selecting subsets of the data on the
different HoloViews datastructures.

* `Transforming Elements <Applying_Transformations.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 <Responding_to_Events.html>`_
* `Tabular Datasets <Tabular_Datasets.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 <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 <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.

* `IPython Magics <IPython_Magics>`_
Using the ``%opts`` and ``%output`` magics to quickly control
display output in the notebook.

* `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

Applying Transformations <Applying_Transformations>
Building Composite Objects <Building_Composite_Objects>
Continuous Coordinates <Continuous_Coordinates>
Custom Interactivity <Custom_Interactivity>
Customizing Plots <Customizing_Plots>
Deploying Bokeh Apps <Deploying_Bokeh_Apps>
Exporting and Archiving <Exporting_and_Archiving>
Gridded Datasets <Gridded_Datasets>
Indexing and Selecting Data <Indexing_and_Selecting_Data>
Live Data <Live_Data>
Plotting with Bokeh <Plotting_with_Bokeh>
Responding to Events <Responding_to_Events>
Tabular Datasets <Tabular_Datasets>
Annotating your Data <Annotating_Data>
Composition of Elements <Composing_Elements>
Customizing Plots <Customizing_Plots>
Dimensioned Containers <Dimensioned_Containers>
Building Composite Objects <Building_Composite_Objects>
Live Data <Live_Data>
Tabular Datasets <Tabular_Datasets>
Gridded Datasets <Gridded_Datasets>
Indexing and Selecting Data <Indexing_and_Selecting_Data>
Transforming Elements <Applying_Transformations>
Responding to Events <Responding_to_Events>
Custom Interactivity <Custom_Interactivity>
Working with large data <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>
IPython Magics <IPython_Magics>
Working with Plot and Renderers <Plots_and_Renderers>
Exporting and Archiving <Exporting_and_Archiving>
Continuous Coordinates <Continuous_Coordinates>

0 comments on commit 948d1f8

Please sign in to comment.