From 5e09d82fb0db2d499820083834a0354697d20011 Mon Sep 17 00:00:00 2001 From: Sean <23040351+ribenamaplesyrup@users.noreply.github.com> Date: Thu, 9 Feb 2023 11:10:14 +0000 Subject: [PATCH] Update README.md --- README.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/README.md b/README.md index ca6e88f..c2cc632 100644 --- a/README.md +++ b/README.md @@ -39,3 +39,14 @@ jupyter nbextension enable --py --sys-prefix ipyleaflet ``` 4. For a quickstart run `voila --no-browser --debug --Voila.ip=0.0.0.0 dashboard/Sugartrail.ipynb --VoilaConfiguration.file_whitelist="['.*']"` and navigate to the url printed in your terminal where Voilà is running at (no-code). For a more detailed explanation of the tool's capabilities, run `jupyter notebook notebooks` and open either `quickstart.ipynb` or `001_getting_started.ipynb`. + +## Examples & Tutorials + +Tutorial | Title | Description | Format +------------- | ------------- | ------------- | ------------- +000 | [Quickstart](https://github.com/ribenamaplesyrup/sugartrail/blob/main/notebooks/quickstart.ipynb) | Get companies, officers and addresses connected to select company and visualise results within basic notebook. | Jupyter Notebook +001 | [Getting Started](https://github.com/ribenamaplesyrup/sugartrail/blob/main/notebooks/001_getting_started.ipynb) | In-depth walkthrough of Sugartrail API. | Jupyter Notebook +002 | [Candy Connections](https://github.com/ribenamaplesyrup/sugartrail/blob/main/notebooks/002_candy_connections.ipynb) | Explore how many of Oxford Street’s souvenir and candy shops can be connected through a single company. | Jupyter Notebook +003 | [Virtual Offices](https://github.com/ribenamaplesyrup/sugartrail/blob/main/notebooks/003_virtual_offices.ipynb) | Explore addresses (such as virtual offices) with thousands of companies registered. This tutorial also compares two different methods of retrieving data from Companies House; the Companies House API and the Companies House Data Product download. | Jupyter Notebook +004 | [Connection Check](https://github.com/ribenamaplesyrup/sugartrail/blob/main/notebooks/004_connection_check.ipynb) | Investigate if two different companies are connected and if so how. | Jupyter Notebook +_ | [Sugartrail Dashboard](https://stark-island-99644.herokuapp.com/) | Get companies, officers and addresses connected to select company and visualise results within basic interface. | Voila Dashboard