Installation Steps

Before starting the installation, please check that your Python version >=3.7. If not, please update your Python version! After that please update your pip version to the latest version:

python -m pip install --upgrade pip

Step1: Install Jupyter

You can choose any of the following ways to install:

  1. Official Jupyter: refer to the official installation tutorial provided by Jupyter:

     pip install jupyterlab


     pip install notebook
  2. VSCode extension: use the Jupyter extension provided by VSCode.

  3. Anaconda: install Anaconda and use the built-in Jupyter Notebook in it.

Step2: Install Graphviz

You can download and install it for free from the official website of Graphviz.

Once installed, add the Graphviz executable path to your system's environment variables!

Step3: Install Algviz

pip install algviz


To make sure you have successfully installed algviz, you can download the test codes from Github. Then call the command:

python tests/

If you see the output like this:

Congratulations, everything is OK !!!

It means algviz works fine in your environment. But if you get any unexpected errors, please report the bug.

After the installation is complete, you can refer to the tutorial to learn how to use Algviz to animate your own algorithm!