In this quick start guide, we're going to show you how to set up and use JupyterLab, a data science environment. JupyterLab is the tool of choice for data scientists around the globe. Using JupyterLab we will run some reports on your own data. All reports are editable so you can quickly start experimenting and exploring more!
This guide is assuming that you are running have Home Assistant not Home Assistant Core (see here for a summary of the differences). Home Assistant is out all-in-one platform and can easily be extended with other software, like JupyterLab. In case you are not using a supervised installation of Home Assistant, please check out the quick start to Home Assistant Data Science for Home Assistant Core users.
To install JupyterLab, we're going to use the JupyterLab Lite add-on by the Community Add-ons project. To get started:
- Click on Supervisor in the panel. Choose "Add-On Store" from the menu.
- Add the Community Add-ons as a new repository with the URL
https://github.com/hassio-addons/repositoryand click on "Add".
- Scroll down to the new section for Community Add-ons and click the install button on JupyterLab Lite. Installation can take a couple of minutes depending on your internet speed.
- Once installed, it will open the JupyterLab Lite add-on page.
- Click on "START" to start the JupyterLab Lite add-on.
- Now click on "OPEN WEB UI" to open JupyterLab.
- You will be prompted for your credentials. You can use the same username and password as that you use to log in to Home Assistant.
- If you get a blank page with "502 Gateway not ready", wait a minute and hit refresh in your browser. JupyterLab can take some time to start up.
Running your first report
JupyterLab works with Jupyter Notebooks. Think of a notebook like a Word document that can also contain code to explore your data.
We have prepared a few notebooks for you that will help you get started. Let's start with the notebook
GETTING STARTED.ipynb that was installed as part of the add-on. You can find it in the left sidebar. This notebook has been prepared by us to automatically read your Home Assistant data and generate a few interesting statistics about your data!
To run the report, click on "Run" in the top menubar and click on "Run All Cells". The notebook will now generate the full report. Depending on the size of your database, this might take some time. The little square brackets with an asterisk (
[*]) to the left of Python code (a cell) will indicate what is currently being executed or about to be executed. Once executed, it will change to
[<number>] (number represents the order cells are executed).
The cool thing about these reports is that you can edit the Python code and execute it again to get the latest results, you don't even need to execute the whole report again to see most changes. After each change, just run the cell (by clicking the "play" button in the toolbar). Executing a cell will run the Python code and show the latest results!
You now have all tools available to you to do data science. If you want to see some more cool notebooks that people have created for Home Assistant, the add-on has installed the Home Assistant Notebook collection. You can also check out the HASS Data Detective usage examples. If you want to see how it can be used for now-Home Assistant related data, the add-on has also installed a couple of other interesting notebook examples.
If you want to learn more about what data Home Assistant tracks, check out the data primer.