Skip to content

How to install Vizro

This guide shows you how to install Vizro, how to verify the installation succeeded and find the version of Vizro, and how to update Vizro.

If you already have a virtual environment setup in Python then you can skip this page and install Vizro straight away by running: 

pip install vizro

Prerequisites

Python: Vizro supports macOS, Linux, and Windows. It works with Python 3.8 and later. You can specify the version of Python to use with Vizro when you set up a virtual environment.

Virtual environment: You should create a virtual environment for each 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.

Prefer to use Vizro without opening a terminal window?

If you are a beginner or coding novice, you may prefer to avoid using a terminal to work with Vizro. Skip to the "Use Vizro inside Anaconda" section below.

How to create a virtual environment for your Vizro project

The simplest way to create a virtual environment in Python is venv, which is included in the Python standard library. Create a directory for your project and navigate to it. For example:

mkdir vizro-project
cd vizro-project

Next, create and activate a new virtual environment in this directory with venv: 

python3 -m venv .venv
source .venv/bin/activate

Alternatively, you might like to use conda as your virtual environment manager. Once installed, you can create and activate a virtual environment from the terminal as follows:

conda create --name vizro-environment
conda activate vizro-environment

Install Vizro

To install Vizro, use pip in your terminal window:

pip install vizro

Use Vizro inside Anaconda Navigator

To completely avoid terminal usage, follow these steps to work with Vizro:

  1. Install Anaconda Navigator.

  2. Create a new environment as outlined in the Anaconda documentation. Choose a Python version >=3.8.

  3. Search vizro and install it using the Anaconda Navigator package manager.

  4. Similarly, search jupyter and install it.

  5. Launch a Jupyter Notebook to work with Vizro.

Confirm a successful installation

To confirm the installation was successful, and verify the version of Vizro installed, call the following. You can do this from within a Jupyter Notebook cell, or run the following as a Python script:

import vizro

print(vizro.__version__)

You should see a return output of the form x.y.z.

Upgrade

To change the version of Vizro installed:

pip install -U vizro

Tip

To upgrade safely, check the release notes for any notable breaking changes before migrating an existing project.