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.

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.

Installation

Make sure you have Conda installed
Download the tool's repository using the command:

git clone https://github.com/ribenamaplesyrup/sugartrail.git

Navigate to the main directory and run:

conda env create -f environment.yml
conda activate candystore
jupyter nbextension enable --py --sys-prefix ipyleaflet
jupyter notebook

Usage

Navigate to Quickstart.ipynb to run the tool without needing to use the API. For a more detailed explanation of the tool's capabilities, head to Tutorial 1 - Get Started.