Skip to content
This repository has been archived by the owner on Apr 16, 2019. It is now read-only.

Commit

Permalink
Merge pull request #102 from marqh/mybinder
Browse files Browse the repository at this point in the history
release ready
  • Loading branch information
marqh committed Jun 8, 2016
2 parents 7757d95 + bb12f12 commit 769b0ee
Show file tree
Hide file tree
Showing 7 changed files with 39 additions and 12 deletions.
22 changes: 13 additions & 9 deletions doc/browsing_cubes/intro.rst
Expand Up @@ -4,6 +4,19 @@ Browsing Cubes
The Cube Browser package enables you to visualize your `Iris cubes <http://scitools.org.uk/iris/docs/latest/userguide/iris_cubes.html>`_ in a Jupyter notebook.
Cube Browser utilizes Python and the matplotlib, Iris and cartopy libraries while offering the additional functionality of plotting an entire cube without having to slice it.

Example Notebooks
-----------------

The example described below shows how to plot a single cube on a single set of axes, but you can also use Cube Browser to make combinations of plots, for example side-by-side plots or overlays.
The links below are examples of how you can achieve these.

`four-axes example <http://mybinder.org/repo/scitools/cube_browser/doc/browsing_cubes/four_axes.ipynb>`_.

`overlay example <http://mybinder.org/repo/scitools/cube_browser/doc/browsing_cubes/overlay.ipynb>`_

Writing a new Notebook
----------------------

You can make use of the Cube Browser library to write a short notebook to display your Iris cube data.
There are several advantages of using this approach, notably the flexibility in the options you can apply to each plot and the relative ease with which you can achieve this.
Additionally, if you know what plots you would like and how you would like them laid out, this is a quick way of producing your plots and exploring your cube data.
Expand Down Expand Up @@ -50,12 +63,3 @@ Finally, you need to make the call to the Browser class to construct the plots w
Browser([plot]).display()


Example Notebooks
-----------------

The example described above shows how to plot a single cube on a single set of axes, but you can also use Cube Browser to make combinations of plots, for example side-by-side plots or overlays.
The links below are examples of how you can achieve these.

`four-axes example <https://nbviewer.jupyter.org/urls/gist.githubusercontent.com/corinnebosley/2fbc9fcb329a2459d926c82eb94386b4/raw/92cfe3b056532e0a469319388495ce4bc212a926/four_axes.ipynb>`_

`overlay example <https://nbviewer.jupyter.org/urls/gist.githubusercontent.com/corinnebosley/7376f8919958027123f2f8ebdb508df3/raw/be561d438842d810fefcf0a90555e4acb8e9dd3c/overlay.ipynb>`_
4 changes: 2 additions & 2 deletions doc/conf.py
Expand Up @@ -12,9 +12,9 @@


# # The short X.Y version.
version = u'v0.1'
version = u'v1.0'
# The full version, including alpha/beta/rc tags.
release = u'v0.1'
release = u'v1.0.0'

# Override default theme
import sphinx_rtd_theme
Expand Down
2 changes: 2 additions & 0 deletions doc/explorers/intro.rst
Expand Up @@ -13,6 +13,8 @@ Links to Cube Explorers

:download:`Click here to download the notebook <explore.ipynb>`

You can see a demonstration version of explorer via the mybinder service. This is freely hosted by generous people, but it is not fast and you should not load your own data into the sessions; it uses Iris sample data instead: `mybinder cube_browser <http://mybinder.org/repo/scitools/cube_browser/doc/explorers/explore.ipynb>`_.

Usage
-----

Expand Down
1 change: 1 addition & 0 deletions doc/index.rst
Expand Up @@ -16,6 +16,7 @@ There are three different ways which you can use Cube Browser:

You can use our ready-made Cube Explorers to choose and plot your Iris cubes.
This is an interactive Graphical User Interface, which is available to :download:`download <explorers/explore.ipynb>`
You can see a demonstration version of explorer via the mybinder service. This is freely hosted by generous people, but it is not fast and you should not load your own data into the sessions; it uses Iris sample data instead: `mybinder cube_browser <http://mybinder.org/repo/scitools/cube_browser/doc/explorers/explore.ipynb>`_.


2. **Browsing cubes:**
Expand Down
16 changes: 16 additions & 0 deletions doc/write_your_own/components/intro.rst
Expand Up @@ -25,14 +25,24 @@ Follow the links below to view some examples of widgets which could be used as c

:download:`Text Input Box <ValueCatcher.ipynb>`

`mybinder Text Input Box <http://mybinder.org/repo/scitools/cube_browser/doc/write_your_own/components/ValueCatcher.ipynb>`_.

:download:`Toggle Button Menu <DimPicker1.ipynb>`

`mybinder Toggle Button Menu <http://mybinder.org/repo/scitools/cube_browser/doc/write_your_own/components/DimPicker1.ipynb>`_.

:download:`Radio Button Menu <DimPicker2.ipynb>`

`mybinder Radio Button Menu <http://mybinder.org/repo/scitools/cube_browser/doc/write_your_own/components/DimPicker2.ipynb>`_.

:download:`Dropdown Menu <DimPicker3.ipynb>`

`mybinder Dropdown Menu <http://mybinder.org/repo/scitools/cube_browser/doc/write_your_own/components/DimPicker3.ipynb>`_.

:download:`Plot Type Selector (Dropdown) <iplotPicker.ipynb>`

`mybinder Plot Type Selector <http://mybinder.org/repo/scitools/cube_browser/doc/write_your_own/components/iplotPicker.ipynb>`_.


**Construct one widget per cell**

Expand All @@ -51,6 +61,8 @@ It is convenient to make a button to achieve this (see button example below) as

:download:`Plotting Button <Button.ipynb>`

`mybinder Plotting Button <http://mybinder.org/repo/scitools/cube_browser/doc/write_your_own/components/Button.ipynb>`_.


Usage
-----
Expand All @@ -64,8 +76,12 @@ This is important if you have any dependencies between widgets (see following no

:download:`Options List <OptionsCascade.ipynb>`

`mybinder Options List <http://mybinder.org/repo/scitools/cube_browser/doc/write_your_own/components/OptionsCascade.ipynb>`_.

:download:`Selection Process <Workflow1.ipynb>`

`mybinder Selection Process <http://mybinder.org/repo/scitools/cube_browser/doc/write_your_own/components/Workflow1.ipynb>`_.


Linking up your Widgets
-----------------------
Expand Down
4 changes: 4 additions & 0 deletions doc/write_your_own/connections/intro.rst
Expand Up @@ -32,7 +32,11 @@ Links to Notebooks:

:download:`Simple File Picker <filePickerSimple.ipynb>`

`mybinder Simple File Picker <http://mybinder.org/repo/scitools/cube_browser/doc/write_your_own/components/filePickerSimple.ipynb>`_.

:download:`Interactions <interactions.ipynb>`

`mybinder Interactions <http://mybinder.org/repo/scitools/cube_browser/doc/write_your_own/components/interactions.ipynb>`_.



2 changes: 1 addition & 1 deletion lib/cube_browser/__init__.py
Expand Up @@ -16,7 +16,7 @@
import matplotlib.pyplot as plt

# Cube-browser version.
__version__ = '0.2.0-dev'
__version__ = '1.0.0'


# Set default IPython magics if an IPython session has invoked the import.
Expand Down

0 comments on commit 769b0ee

Please sign in to comment.