home-assistant.github.io/ecosystem/notebooks/installation/index.html
2017-02-14 14:15:31 +00:00

193 lines
No EOL
8.4 KiB
HTML

<!doctype html>
<!--[if lt IE 7]> <html class="no-js lt-ie9 lt-ie8 lt-ie7"> <![endif]-->
<!--[if IE 7]> <html class="no-js lt-ie9 lt-ie8"> <![endif]-->
<!--[if IE 8]> <html class="no-js lt-ie9"> <![endif]-->
<!--[if gt IE 8]><!--> <html> <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
<title>Installation - Home Assistant</title>
<meta name="author" content="Home Assistant">
<meta name="description" content="Setup and first steps for Jupyter Notebooks and Home Assistant.">
<meta name="viewport" content="width=device-width">
<link rel="canonical" href="https://home-assistant.io/ecosystem/notebooks/installation/">
<meta property="fb:app_id" content="338291289691179">
<meta property="og:title" content="Installation">
<meta property="og:site_name" content="Home Assistant">
<meta property="og:url" content="https://home-assistant.io/ecosystem/notebooks/installation/">
<meta property="og:type" content="article">
<meta property="og:description" content="Setup and first steps for Jupyter Notebooks and Home Assistant.">
<meta property="og:image" content="https://home-assistant.io/images/default-social.png">
<meta name="twitter:card" content="summary_large_image">
<meta name="twitter:site" content="@home_assistant">
<meta name="twitter:title" content="Installation">
<meta name="twitter:description" content="Setup and first steps for Jupyter Notebooks and Home Assistant.">
<meta name="twitter:image" content="https://home-assistant.io/images/default-social.png">
<link href="/stylesheets/screen.css" media="screen, projection" rel="stylesheet">
<link href="/atom.xml" rel="alternate" title="Home Assistant" type="application/atom+xml">
<link rel='shortcut icon' href='/images/favicon.ico' />
<link rel='icon' type='image/png' href='/images/favicon-192x192.png' sizes='192x192' />
</head>
<body >
<header>
<div class="grid-wrapper">
<div class="grid">
<div class="grid__item three-tenths lap-two-sixths palm-one-whole ha-title">
<a href="/" class="site-title">
<img width='40' src='/demo/favicon-192x192.png'>
<span>Home Assistant</span>
</a>
</div>
<div class="grid__item seven-tenths lap-four-sixths palm-one-whole">
<nav>
<input type="checkbox" id="toggle">
<label for="toggle" class="toggle" data-open="Main Menu" data-close="Close Menu"></label>
<ul class="menu pull-right">
<li><a href="/getting-started/">Getting started</a></li>
<li><a href="/components/">Components</a></li>
<li><a href="/ecosystem/">Ecosystem</a></li>
<li><a href="/cookbook/">Examples</a></li>
<li><a href="/developers/">Developers</a></li>
<li><a href="/blog/">Blog</a></li>
<li><a href="/help/">Need help?</a></li>
</ul>
</nav>
</div>
</div>
</div>
</header>
<div class="grid-wrapper">
<div class="grid grid-center">
<div class="grid__item two-thirds lap-one-whole palm-one-whole">
<article class="page">
<div class='edit-github'><a href='https://github.com/home-assistant/home-assistant.github.io/tree/current/source/_ecosystem/notebooks/installation.markdown'>Edit this page on GitHub</a></div>
<header>
<h1 class="title indent">
Installation
</h1>
</header>
<hr class="divider">
<p>To run Jupyter Notebooks locally, an installation of <a href="http://jupyter.org/">Jupyter</a> is needed. Consider to run Jupyter in a <a href="/getting-started/installation-virtualenv/">virtualenv</a>.</p>
<div class="language-bash highlighter-rouge"><pre class="highlight"><code><span class="gp">$ </span>pip3 install jupyter matplotlib
</code></pre>
</div>
<p class="note warning">
Certain notebooks hosted in the <a href="https://github.com/home-assistant/home-assistant-notebooks">Home Assistant notebooks repository</a> 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 <code class="highlighter-rouge">$ pip3 install homeassistant</code> as well.
</p>
<p>Now you are able to start the application.</p>
<div class="language-bash highlighter-rouge"><pre class="highlight"><code><span class="gp">$ </span>jupyter notebook
<span class="o">[</span>I 17:22:18.081 NotebookApp] Writing notebook server cookie secret to /run/user/1000/jupyter/notebook_cookie_secret
<span class="o">[</span>I 17:22:18.921 NotebookApp] Serving notebooks from <span class="nb">local </span>directory: /home/fabaff/home-assistant
<span class="o">[</span>I 17:22:18.921 NotebookApp] 0 active kernels
<span class="o">[</span>I 17:22:18.921 NotebookApp] The Jupyter Notebook is running at: http://localhost:8888/
<span class="o">[</span>I 17:22:18.922 NotebookApp] Use Control-C to stop this server and shut down all kernels <span class="o">(</span>twice to skip confirmation<span class="o">)</span>.
</code></pre>
</div>
<p>Open <a href="http://localhost:8888/">http://localhost:8888/</a> in your browser. Press “New” -&gt; “Python3” to open a new notebook.</p>
<p class="img">
<img src="/images/screenshots/jupyter-new.png" />
</p>
<p>You will get an empty notebook with one cell. Cells can contain code or text. To get the output of a cell you need to execute them with “Cell” -&gt; “Run Cells” from the menu or by pressing the icon.</p>
<p class="img">
<img src="/images/screenshots/jupyter-notebook.png" />
</p>
<p>The downloadable version of this notebook is available in the <a href="https://github.com/home-assistant/home-assistant-notebooks/blob/master/first-notebook.ipynb">Home Assistant notebooks repository</a>.</p>
<p>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.</p>
</article>
</div>
<aside id="sidebar" class="grid__item one-third lap-one-whole palm-one-whole">
<div class="grid">
<section class="aside-module grid__item one-whole lap-one-half">
<div class="section">
<h1 class="title delta">Jupyter Notebooks</h1>
<ul class="divided sidebar-menu">
<li><a href='/ecosystem/notebooks/'>Introduction </a></li>
<li><a class='active' href='/ecosystem/notebooks/installation/'>Installation </a></li>
<li><a href='/ecosystem/notebooks/graph/'>Graph </a></li>
<li><a href='/ecosystem/notebooks/api/'>Home Assistant API </a></li>
<li><a href='/ecosystem/notebooks/Database/'>Databsase </a></li>
<li><a href='/ecosystem/notebooks/stats/'>Statistics </a></li>
</ul>
</div>
</section>
</div>
</aside>
</div>
</div>
<footer>
<div class="grid-wrapper">
<div class="grid">
<div class="grid__item">
<div class="copyright">
<a rel="me" href='https://twitter.com/home_assistant'><i class="icon-twitter"></i></a>
<a rel="me" href='https://facebook.com/homeassistantio'><i class="icon-facebook"></i></a>
<a rel="me" href='https://plus.google.com/110560654828510104551'><i class="icon-google-plus"></i></a>
<a rel="me" href='https://github.com/home-assistant/home-assistant'><i class="icon-github"></i></a>
<div class="credit">
Contact us at <a href='mailto:hello@home-assistant.io'>hello@home-assistant.io</a>.<br>
Website powered by <a href='http://jekyllrb.com/'>Jekyll</a> and the <a href='https://github.com/coogie/oscailte'>Oscalite theme</a>.<br />
Hosted by <a href='https://pages.github.com/'>GitHub</a> and served by <a href='https://cloudflare.com'>CloudFlare</a>.
</div>
<a rel="license" href="http://creativecommons.org/licenses/by-nc-sa/4.0/"><img alt="Creative Commons License" style="border-width:0" src="https://i.creativecommons.org/l/by-nc-sa/4.0/88x31.png" /></a><br /><span xmlns:dct="http://purl.org/dc/terms/" property="dct:title">home-assistant.io</span> is licensed under a <a rel="license" href="http://creativecommons.org/licenses/by-nc-sa/4.0/">Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License</a>.
</div>
</div>
</div>
</div>
</footer>
<script>
var _gaq=[['_setAccount','UA-57927901-1'],['_trackPageview']];
(function(d,t){var g=d.createElement(t),s=d.getElementsByTagName(t)[0];
g.src=('https:'==location.protocol?'//ssl':'//www')+'.google-analytics.com/ga.js';
s.parentNode.insertBefore(g,s)}(document,'script'));
</script>
</body>
</html>