Skip to content

How to install the framework

The following data analysis framework is a set of tools built on Python 3.7 to help you analyse your data. It can be used with Jupyter Notebooks or Jupyter Lab, although it is not mandatory.

Before getting started

The framework runs in python 3.6 or more. Download and install python following this guide if you don't already have it.


Open your favourite shell on the directory you have your project. (cmd.exe on windows)

pip install scdata

Development instructions (advanced)

  1. Get the repo

Make a directory and clone the repository in it:

mkdir smartcitizen-data
cd smartcitizen-data
git clone

Want to stay up-to-date?

The framework is being constantly updated and the only version that will always be up-to-date is in the master branch of the github repository. We do not recommend to simply download the repository but to clone it with git. If you want to learn more about git and why it can help you in your projects, check here

  1. Finish it up

The code in the framework is managed as internal dependencies. To activate this, you can run:

python install


You should now be ready to go! You can verify the installation by either running this command:

jupyter lab --version

To run jupyter lab, in your terminal type:

jupyter lab

This will open a web browser instance (by default localhost:8888/lab) which gives access to the tools in the framework.

Learn More

Still wondering what this is? Read this introduction to Jupyter