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 config/environment.yml
conda activate candystore
pip install -e .
jupyter nbextension enable --py --sys-prefix ipyleaflet

Usage

For a quickstart run voila dashboard/quickstart_voila.ipynb (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.