From a29817513f7d794ef4d73d7104b8c86bded3c5cd Mon Sep 17 00:00:00 2001 From: Fabian Affolter Date: Thu, 26 Jan 2017 16:35:28 +0100 Subject: [PATCH] Move Jupyter docs from cookbook to Ecosystem (#1860) --- .../jupyter_notebooks_graph.markdown | 13 ------------ source/_ecosystem/notebooks.markdown | 20 +++++++++++++++++++ .../notebooks/api.markdown} | 5 ++--- .../notebooks/database.markdown} | 5 ++--- source/_ecosystem/notebooks/graph.markdown | 12 +++++++++++ .../notebooks/installation.markdown} | 11 +++------- .../notebooks/stats.markdown} | 3 +-- 7 files changed, 40 insertions(+), 29 deletions(-) delete mode 100644 source/_cookbook/jupyter_notebooks_graph.markdown create mode 100644 source/_ecosystem/notebooks.markdown rename source/{_cookbook/jupyter_notebooks_api.markdown => _ecosystem/notebooks/api.markdown} (50%) rename source/{_cookbook/jupyter_notebooks_database.markdown => _ecosystem/notebooks/database.markdown} (53%) create mode 100644 source/_ecosystem/notebooks/graph.markdown rename source/{_cookbook/jupyter_notebooks_introduction.markdown => _ecosystem/notebooks/installation.markdown} (75%) rename source/{_cookbook/jupyter_notebooks_stats.markdown => _ecosystem/notebooks/stats.markdown} (82%) diff --git a/source/_cookbook/jupyter_notebooks_graph.markdown b/source/_cookbook/jupyter_notebooks_graph.markdown deleted file mode 100644 index 8e857c397e4..00000000000 --- a/source/_cookbook/jupyter_notebooks_graph.markdown +++ /dev/null @@ -1,13 +0,0 @@ ---- -layout: page -title: "Jupyter Notebooks Graph" -description: "Basic example how to create a graph with a Jupyter notebook." -date: 2016-07-23 09:00 -sidebar: true -comments: false -sharing: true -footer: true -ha_category: Jupyter Notebooks -ha_external_link: https://github.com/home-assistant/home-assistant-notebooks/blob/master/graph-single-sensor.ipynb ---- - diff --git a/source/_ecosystem/notebooks.markdown b/source/_ecosystem/notebooks.markdown new file mode 100644 index 00000000000..6dfd9a73633 --- /dev/null +++ b/source/_ecosystem/notebooks.markdown @@ -0,0 +1,20 @@ +--- +layout: page +title: "Jupyter Notebooks" +description: "Jupyter Notebooks to interact offline and online with Home Assistant." +release_date: 2016-11-13 15:00:00 +sidebar: true +comments: false +sharing: true +footer: true +--- + +The [Jupyter Notebooks](http://jupyter.org/) allows you to create and share documents that contain live code, equations, visualizations, and explanatory text directly in your browser. The web application what is formerly known as the IPython Notebook supports over 40 programming languages. + +Visit [https://try.jupyter.org/](https://try.jupyter.org/) to get a preview before you install it locally. + +

+ +

+ +[nbviewer](http://nbviewer.jupyter.org/github/home-assistant/home-assistant-notebooks/tree/master/) is rendering our notebooks online. GitHub is creating a preview as well. diff --git a/source/_cookbook/jupyter_notebooks_api.markdown b/source/_ecosystem/notebooks/api.markdown similarity index 50% rename from source/_cookbook/jupyter_notebooks_api.markdown rename to source/_ecosystem/notebooks/api.markdown index 4daaad35a5f..eb6d00aa6af 100644 --- a/source/_cookbook/jupyter_notebooks_api.markdown +++ b/source/_ecosystem/notebooks/api.markdown @@ -1,13 +1,12 @@ --- layout: page -title: "Notebook for Home Assistant Python API" +title: "Home Assistant Python API" description: "Basic example how to work with the Home Assistant Python API in a Jupyter notebook." date: 2016-07-23 09:00 sidebar: true comments: false sharing: true footer: true -ha_category: Jupyter Notebooks -ha_external_link: https://github.com/home-assistant/home-assistant-notebooks/blob/master/home-assistant-python-api.ipynb +ha_external_link: http://nbviewer.jupyter.org/github/home-assistant/home-assistant-notebooks/blob/master/home-assistant-python-api.ipynb --- diff --git a/source/_cookbook/jupyter_notebooks_database.markdown b/source/_ecosystem/notebooks/database.markdown similarity index 53% rename from source/_cookbook/jupyter_notebooks_database.markdown rename to source/_ecosystem/notebooks/database.markdown index 22802cd0709..9c62f5c79f7 100644 --- a/source/_cookbook/jupyter_notebooks_database.markdown +++ b/source/_ecosystem/notebooks/database.markdown @@ -1,13 +1,12 @@ --- layout: page -title: "Jupyter Notebooks Database" +title: "Database" description: "Basic example how to work with stored Home Assistant information in a Jupyter notebook." date: 2016-07-23 09:00 sidebar: true comments: false sharing: true footer: true -ha_category: Jupyter Notebooks -ha_external_link: https://github.com/home-assistant/home-assistant-notebooks/blob/master/database-examples.ipynb +ha_external_link: http://nbviewer.jupyter.org/github/home-assistant/home-assistant-notebooks/blob/master/database-examples.ipynb --- diff --git a/source/_ecosystem/notebooks/graph.markdown b/source/_ecosystem/notebooks/graph.markdown new file mode 100644 index 00000000000..ce0dc91cede --- /dev/null +++ b/source/_ecosystem/notebooks/graph.markdown @@ -0,0 +1,12 @@ +--- +layout: page +title: "Graph" +description: "Basic example how to create a graph with a Jupyter notebook." +date: 2016-07-23 09:00 +sidebar: true +comments: false +sharing: true +footer: true +ha_external_link: http://nbviewer.jupyter.org/github/home-assistant/home-assistant-notebooks/blob/master/graph-single-sensor.ipynb +--- + diff --git a/source/_cookbook/jupyter_notebooks_introduction.markdown b/source/_ecosystem/notebooks/installation.markdown similarity index 75% rename from source/_cookbook/jupyter_notebooks_introduction.markdown rename to source/_ecosystem/notebooks/installation.markdown index d4ed78b50c4..ffc67af78d2 100644 --- a/source/_cookbook/jupyter_notebooks_introduction.markdown +++ b/source/_ecosystem/notebooks/installation.markdown @@ -1,27 +1,22 @@ --- layout: page -title: "Jupyter Notebooks Introduction" +title: "Installation" description: "Setup and first steps for Jupyter Notebooks and Home Assistant." date: 2016-07-23 09:00 sidebar: true comments: false sharing: true footer: true -ha_category: Jupyter Notebooks --- -The [Jupyter Notebooks](http://jupyter.org/) allows you to create and share documents that contain live code, equations, visualizations, and explanatory text directly in your browser. The web application what is formerly known as the IPython Notebook supports over 40 programming languages. - -Visit [https://try.jupyter.org/](https://try.jupyter.org/) to get a preview before you install it locally. - -The very first step is to install the requirement to run Jupyter Notebooks. +To run Jupyter Notebooks locally, an installation of [Jupyter](http://jupyter.org/) is needed. Consider to run Jupyter in a [virtualenv](/getting-started/installation-virtualenv/). ```bash $ pip3 install jupyter matplotlib ```

-Certain notebooks hosted in the [Home Assistant notebooks repository](https://github.com/home-assistant/home-assistant-notebooks) require access to a running Home Assistant instance or parts of a Home Assistant installation. If you want to run those notebooks install Home Assistant with `$ pip3 install homeassistant` as well. +Certain notebooks hosted in the [Home Assistant notebooks repository](https://github.com/home-assistant/home-assistant-notebooks) require access to a running Home Assistant instance or parts of a Home Assistant installation. If you want to run those notebooks, install Home Assistant with `$ pip3 install homeassistant` as well.

Now you are able to start the application. diff --git a/source/_cookbook/jupyter_notebooks_stats.markdown b/source/_ecosystem/notebooks/stats.markdown similarity index 82% rename from source/_cookbook/jupyter_notebooks_stats.markdown rename to source/_ecosystem/notebooks/stats.markdown index a770b3b057a..35582c9abfa 100644 --- a/source/_cookbook/jupyter_notebooks_stats.markdown +++ b/source/_ecosystem/notebooks/stats.markdown @@ -1,13 +1,12 @@ --- layout: page -title: "Jupyter Notebooks Statistics" +title: "Statistics" description: "Basic example how to create basic statistics with a Jupyter notebook." date: 2016-10-03 09:00 sidebar: true comments: false sharing: true footer: true -ha_category: Jupyter Notebooks ha_external_link: http://nbviewer.jupyter.org/github/home-assistant/home-assistant-notebooks/blob/master/database-statistics.ipynb ---