From bb12f123e7f94b615456eefe0cc4cad890d047f6 Mon Sep 17 00:00:00 2001 From: marqh Date: Wed, 8 Jun 2016 17:21:00 +0000 Subject: [PATCH] release ready --- doc/browsing_cubes/intro.rst | 22 +++++++++++++--------- doc/conf.py | 4 ++-- doc/explorers/intro.rst | 2 ++ doc/index.rst | 1 + doc/write_your_own/components/intro.rst | 16 ++++++++++++++++ doc/write_your_own/connections/intro.rst | 4 ++++ lib/cube_browser/__init__.py | 2 +- 7 files changed, 39 insertions(+), 12 deletions(-) diff --git a/doc/browsing_cubes/intro.rst b/doc/browsing_cubes/intro.rst index 3d6f975..5efbd4e 100644 --- a/doc/browsing_cubes/intro.rst +++ b/doc/browsing_cubes/intro.rst @@ -4,6 +4,19 @@ Browsing Cubes The Cube Browser package enables you to visualize your `Iris cubes `_ 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 `_. + +`overlay example `_ + +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. @@ -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 `_ - -`overlay example `_ diff --git a/doc/conf.py b/doc/conf.py index 0acd005..f596820 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -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 diff --git a/doc/explorers/intro.rst b/doc/explorers/intro.rst index 28c3c72..2cf3256 100644 --- a/doc/explorers/intro.rst +++ b/doc/explorers/intro.rst @@ -13,6 +13,8 @@ Links to Cube Explorers :download:`Click here to download the notebook ` +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 `_. + Usage ----- diff --git a/doc/index.rst b/doc/index.rst index f78db8f..98406df 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -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 ` + 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 `_. 2. **Browsing cubes:** diff --git a/doc/write_your_own/components/intro.rst b/doc/write_your_own/components/intro.rst index ce97e2a..eff13c0 100644 --- a/doc/write_your_own/components/intro.rst +++ b/doc/write_your_own/components/intro.rst @@ -25,14 +25,24 @@ Follow the links below to view some examples of widgets which could be used as c :download:`Text Input Box ` +`mybinder Text Input Box `_. + :download:`Toggle Button Menu ` +`mybinder Toggle Button Menu `_. + :download:`Radio Button Menu ` +`mybinder Radio Button Menu `_. + :download:`Dropdown Menu ` +`mybinder Dropdown Menu `_. + :download:`Plot Type Selector (Dropdown) ` +`mybinder Plot Type Selector `_. + **Construct one widget per cell** @@ -51,6 +61,8 @@ It is convenient to make a button to achieve this (see button example below) as :download:`Plotting Button ` +`mybinder Plotting Button `_. + Usage ----- @@ -64,8 +76,12 @@ This is important if you have any dependencies between widgets (see following no :download:`Options List ` +`mybinder Options List `_. + :download:`Selection Process ` +`mybinder Selection Process `_. + Linking up your Widgets ----------------------- diff --git a/doc/write_your_own/connections/intro.rst b/doc/write_your_own/connections/intro.rst index 4547a18..68be23e 100644 --- a/doc/write_your_own/connections/intro.rst +++ b/doc/write_your_own/connections/intro.rst @@ -32,7 +32,11 @@ Links to Notebooks: :download:`Simple File Picker ` +`mybinder Simple File Picker `_. + :download:`Interactions ` +`mybinder Interactions `_. + diff --git a/lib/cube_browser/__init__.py b/lib/cube_browser/__init__.py index 8493eed..a2995ea 100644 --- a/lib/cube_browser/__init__.py +++ b/lib/cube_browser/__init__.py @@ -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.