跳转至

安装

系统需求

创建项目前请先安装以下工具:

安装 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"

也可通过包管理工具安装:

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

安装软件包

utility-viz 2.0 目前处于 Beta 阶段

utility-viz 2.0.0b1 是预发布版本(pre-release)。在 2.0 正式版发布之前,稳定版仍是 econ-viz 1.x。 预发布版本默认会被跳过,因此下面的命令加上了 --pre(pip)或 --prerelease allow(uv)。 从 econ-viz 升级?请见从 econ-viz 迁移。

使用 pip:

pip install --pre utility-viz

使用 uv,创建项目并将 utility-viz 添加为依赖:

uv init my-diagrams
cd my-diagrams
uv add --prerelease allow utility-viz

通过 uv run 在项目环境中运行代码:

uv run python main.py

可选依赖

部分功能需要额外的包,可按需安装对应的可选依赖:

uv add --prerelease allow "utility-viz[animation]"    # GIF 导出(Pillow)
uv add --prerelease allow "utility-viz[interactive]"  # 笔记本交互组件
uv add --prerelease allow "utility-viz[all]"          # 全部可选依赖

全局安装命令行工具

若仅需命令行工具,可将其安装为独立工具,使 utility-viz 加入 PATH:

uv tool install --prerelease allow utility-viz

开发环境配置

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

uv sync 默认会安装 dev 依赖组,--all-extras 则会一并安装所有可选依赖。运行测试:

uv run pytest

验证安装

uv run utility-viz --version
uv run utility-viz help

评论