Skip to content

Latest commit

 

History

History
54 lines (35 loc) · 3.82 KB

README.md

File metadata and controls

54 lines (35 loc) · 3.82 KB
Raw

Sugartrail

title

Sugartrail is a network analysis and visualisation tool developed to make it easier and faster for researchers to explore connections between companies, officers and addresses within Companies House. The tool can be used for the following use-cases:

  • Get all companies, officers and addresses connected to a company within n degrees of seperation, based upon user-defined connection criteria. If two companies are connected, get the path of companies, officers and addresses connecting those companies.
  • Check if a selection of companies, officers and addresses are connected within n degrees of seperation, and visualise the paths that connect them.

title

Requirements

You will require an API key from Companies House to get data. First you will need to create a live application to get an API key which you can do by following the Companies House guide.

No-Install Usage

A hosted demo of the Sugartrail dashboard can be accessed here (might take a few seconds to load the page). This demo times out after 30 mins so may not be suitable for building large networks at present.

Demo

img

Installation

  1. Make sure you have Conda installed

  2. Download the tool's repository using the command:

git clone https://github.com/ribenamaplesyrup/sugartrail.git
  1. Navigate to the main directory and run:
conda create -n candystore python=3.10
conda activate candystore
pip install -e .
  1. For a quickstart run python -m voila --no-browser --debug dashboard/Sugartrail.ipynb --VoilaConfiguration.file_allowlist="['.*']" 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 Get companies, officers and addresses connected to select company and visualise results within basic notebook. Jupyter Notebook
001 Getting Started In-depth walkthrough of Sugartrail API. Jupyter Notebook
002 Candy Connections Explore how many of Oxford Street’s souvenir and candy shops are connected through a single company 🇺🇸🇬🇧🍬 Jupyter Notebook
003 Virtual Offices 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 Investigate if two different companies are connected and if so how. Jupyter Notebook
005 Connection Visualise Visualise how 7 networks interconnect. Jupyter Notebook
_ Sugartrail Dashboard Get companies, officers and addresses connected to select company and visualise results within basic interface. Voila Dashboard