bellingcat/sugartrail
1
0
Fork 0
mirror of https://github.com/bellingcat/sugartrail.git synced 2026-06-08 03:28:31 +03:00
Code Issues Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Sean
2022-12-31 17:03:31 +00:00
committed by GitHub
parent 778494bc1f
commit 0b1b69f047
1 changed files with 5 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
README.md
View File

@@ -8,6 +8,10 @@ Sugartrail is a network analysis and visualisation tool developed to make it eas
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](https://developer.company-information.service.gov.uk/how-to-create-an-application).
## Usage
A hosted demo of the Sugartrail dashboard can be accessed [here](https://stark-island-99644.herokuapp.com/).
## Installation
1. Make sure you have Conda installed
@@ -27,6 +31,5 @@ pip install -e .
jupyter nbextension enable --py --sys-prefix ipyleaflet
```
## Usage
4. 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`.
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`.