How to install the frameworkLink
We recommend you use these two tools for managing the different versions of the framework and keep it updated.
Open your favourite shell on the directory you have your project. (
cmd.exe on windows)
Get the repoLink
Make a directory and
clone the repository in it:
➜ mkdir data_analysis ➜ cd data_analysis ➜ git clone https://github.com/fablabbcn/smartcitizen-iscape-data.git ...
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
Create the environmentLink
Navigate to the cloned repository and create an environment for anaconda. We provide an
environment.yml file to help with the process:
➜ cd smartcitizen-iscape-data ➜ smartcitizen-iscape-data git:(master) ✗ conda env create -f environment.yml
Alternatively, you can open Anaconda Navigator and
Import an environment in the
Note about different platforms
Different platforms (Windows, Mac, Linux...) may have different dependencies for each package. We have tried to make the environment as clean as possible, but there might be still some
ModuleNotFound Errors. Please, use the issue tracker in the project to help us improve!
Finish it upLink
The code in the framework is managed as internal dependencies. To activate this, you can run:
➜ pip install --editable . --verbose
Additional commands to install jupyter lab extensions are given in the
jupyter labextension install @firstname.lastname@example.org jupyter labextension install @jupyterlab/toc jupyter labextension install email@example.com conda install -c conda-forge jupyter_nbextensions_configurator
With an optional one for plotly chart studio:
jupyter labextension install firstname.lastname@example.org
You can run it by:
➜ chmod +x .dotfile ➜ ./.dotfile
You should now be ready to go! You can verify the installation by either running this command:
(smartcitizen-data) ➜ ~ jupyter lab --version 1.0.2
Or opening Anaconda Navigator:
To run the framework, in your terminal type:
(smartcitizen-data) ➜ smartcitizen-iscape-data git:(master) ✗ jupyter lab
This will open a web browser instance (by default localhost:8888/lab) which gives access to the tools in the framework.
Still wondering what this is? Read this introduction to Jupyter