Skip to content

Installation

Requirements

Install these tools before creating a project:

Install uv

curl -LsSf https://astral.sh/uv/install.sh | sh

curl -LsSf https://astral.sh/uv/install.sh | sh

powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex"

Alternatively, use a package manager:

brew install uv

sudo port install uv

winget install --id=astral-sh.uv -e

scoop install main/uv

pipx install uv

cargo install --locked uv

Install econ-viz

Create a project and add econ-viz as a dependency:

uv init my-diagrams
cd my-diagrams
uv add econ-viz

Run scripts inside the project environment with uv run:

uv run python main.py

Optional dependencies

Extras enable features that require additional packages:

uv add "econ-viz[animation]"    # GIF export (Pillow)
uv add "econ-viz[interactive]"  # notebook widgets
uv add "econ-viz[all]"          # all extras

Global CLI installation

To use only the command-line interface, install it as a standalone tool so econ-viz is available on your PATH:

uv tool install econ-viz

Development setup

git clone https://github.com/EconViz/econ-viz.git
cd econ-viz
uv sync --all-extras

uv sync installs the dev dependency group by default; --all-extras also installs every optional dependency. Run the test suite with:

uv run pytest

Verifying the installation

uv run econ-viz --version   # econ-viz 1.10.0
uv run econ-viz help

Comments