Installation Tips


We transpile or build Javascript code

npm install node_modules/.bin/webpack --config webpack.config.js --mode=production

If you are debugging the code, it is helpful to build the javascript code in development mode, in which you can trace the javascript source code in your browser debugger. –watch tells webpack to monitor the code changes and recompile automatically.

node_modules/.bin/webpack --watch --config webpack.config.js --mode=development

Upgrade Python

Our python code requires Python3.7 and above. To install the proper Python versions, we recommend [pyenv](, especially for Mac users.

Homebrew on Mac can directly install pyenv

brew update && brew install pyenv

Otherwise, you can follow the pyenv [installation tutorial]( Next, install Python 3.8.2

pyenv install 3.8.2

Set it as global default

pyenv global 3.8.2

Adding the new Python to your PATH

export PATH=$(pyenv root)/shims:$PATH

On Ubuntu, you can also use deadsnakes ppa to install different versions of Python. Ubuntu 18.04 or later provides the package of Python 3.8 directly.

sudo apt-get update sudo apt-get install -y python3.8 python3.8-dev \
    python3-pip python3-setuptools

Redis security

Please make sure secure your redis server following By default redis will backup to local file storage, so ensure you have enough disk space or disable backups inside redis.conf.

Backward compatibility

We are doing our best to make sure that our system can be stable and the internal data can be reused in the new updates. At the same time, we are also iterating on the internal design so that it can be more efficient and versatile. In some cases, we have to break the backward compatibility for the internal data storage. When this happens to your project, you can export the labels from the old project and import them to the new project with the new code. We definitely hope you can enjoy the new features we constantly add to Scalabel.