Skip to content

How to install Vizro

This guide shows you how to install Vizro. It will provide detailed explanation on how to install, update and verify the current version of vizro.

Prerequisites

  • Python: Vizro supports macOS, Linux, and Windows. It is designed to work with Python 3.8 and above. The python version can be specified when setting up your virtual environment.
  • Virtual environment: We suggest to create a new virtual environment for each new Vizro project you work on to isolate its Python dependencies from those of other projects. See the following references to learn more about python virtual environments, conda virtual environments or watch an explainer video about them.
Beginners/Code novices

If you consider yourself a beginner or coding novice, you can follow the steps in these boxes to completely avoid the terminal usage

Install

To install Vizro from the Python Package Index (PyPI), use pip in your terminal window:

pip install vizro

You can run any code from the tutorials and user guides using a python script, but it is arguably more convenient to use a Jupyter notebook. In this case you can optionally install jupyter:

pip install jupyter

Beginners/Code novices

If you consider yourself a beginner or coding novice, you can follow the steps in these boxes to completely avoid the terminal usage

Verify version

Once Vizro is installed, if you would like to verify the version of Vizro or check if everything worked, simply run the following code from a python script or a Jupyter notebook cell:

import vizro

print(vizro.__version__)

You should see a return output of the form 0.1.0.

Upgrade

To later upgrade Vizro to a different version, simply run:

pip install vizro -U

The best way to safely upgrade is to check the release notes for any notable breaking changes before migrating an existing project.