mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-07-19 15:26:59 +00:00
Jupyter notebooks (#665)
* Add initial jupyter docs * Add new screenshot and put basic ha usage to a new page * Update * Rename file * Only use links
This commit is contained in:
parent
d898611a17
commit
b7b95f9459
13
source/_cookbook/jupyther_notebooks_api.markdown
Normal file
13
source/_cookbook/jupyther_notebooks_api.markdown
Normal file
@ -0,0 +1,13 @@
|
||||
---
|
||||
layout: page
|
||||
title: "Notebook for 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
|
||||
---
|
||||
|
13
source/_cookbook/jupyther_notebooks_database.markdown
Normal file
13
source/_cookbook/jupyther_notebooks_database.markdown
Normal file
@ -0,0 +1,13 @@
|
||||
---
|
||||
layout: page
|
||||
title: "Jupyter Notebooks 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
|
||||
---
|
||||
|
13
source/_cookbook/jupyther_notebooks_graph.markdown
Normal file
13
source/_cookbook/jupyther_notebooks_graph.markdown
Normal file
@ -0,0 +1,13 @@
|
||||
---
|
||||
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
|
||||
---
|
||||
|
55
source/_cookbook/jupyther_notebooks_introduction.markdown
Normal file
55
source/_cookbook/jupyther_notebooks_introduction.markdown
Normal file
@ -0,0 +1,55 @@
|
||||
---
|
||||
layout: page
|
||||
title: "Jupyter Notebooks Introduction"
|
||||
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.
|
||||
|
||||
```bash
|
||||
$ pip3 install jupyter matplotlib
|
||||
```
|
||||
|
||||
<p class='note warning'>
|
||||
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.
|
||||
</p>
|
||||
|
||||
Now you are able to start the application.
|
||||
|
||||
```bash
|
||||
$ jupyter notebook
|
||||
[I 17:22:18.081 NotebookApp] Writing notebook server cookie secret to /run/user/1000/jupyter/notebook_cookie_secret
|
||||
[I 17:22:18.921 NotebookApp] Serving notebooks from local directory: /home/fabaff/home-assistant
|
||||
[I 17:22:18.921 NotebookApp] 0 active kernels
|
||||
[I 17:22:18.921 NotebookApp] The Jupyter Notebook is running at: http://localhost:8888/
|
||||
[I 17:22:18.922 NotebookApp] Use Control-C to stop this server and shut down all kernels (twice to skip confirmation).
|
||||
```
|
||||
|
||||
Open [http://localhost:8888/](http://localhost:8888/) in your browser. Press "New" -> "Python3" to open a new notebook.
|
||||
|
||||
<p class='img'>
|
||||
<img src='{{site_root}}/images/screenshots/jupyter-new.png' />
|
||||
</p>
|
||||
|
||||
You will get an emtpy notebook with one cell. Cells can contain code or text. To get the output of a cell you need to execute them with "Cell" -> "Run Cells" from the menu or by pressing the icon.
|
||||
|
||||
<p class='img'>
|
||||
<img src='{{site_root}}/images/screenshots/jupyter-notebook.png' />
|
||||
</p>
|
||||
|
||||
The downloadable version of this notebook is available in the [Home Assistant notebooks repository](https://github.com/home-assistant/home-assistant-notebooks/blob/master/first-notebook.ipynb).
|
||||
|
||||
|
||||
As you can see is the workflow very similar to working directly with a Python shell. One advantage is that you can go back and forth as you please and save your work.
|
||||
|
||||
|
BIN
source/images/screenshots/jupyter-graph.png
Normal file
BIN
source/images/screenshots/jupyter-graph.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 11 KiB |
BIN
source/images/screenshots/jupyter-new.png
Normal file
BIN
source/images/screenshots/jupyter-new.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 11 KiB |
BIN
source/images/screenshots/jupyter-notebook.png
Normal file
BIN
source/images/screenshots/jupyter-notebook.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 134 KiB |
Loading…
x
Reference in New Issue
Block a user