跳转至

快速安装

Pockit 支持 Python 3.11 及以上版本。对大多数用户而言,最省事也最稳妥的方式是 从 conda-forge 安装:Pockit、CyIpopt 和原生 Ipopt 库会一并配置好,无需在本机 编译。Conda 包名为 pockit-optimal-control,在 Python 代码中仍使用 pockit 导入。

推荐:conda-forge

新建独立环境并安装 Pockit:

conda create -n pockit -c conda-forge pockit-optimal-control
conda activate pockit

这一个包就会同时安装 Ipopt 和 SciPy 两种后端。需要运行带绘图的示例时,再安装 Matplotlib:

conda install -c conda-forge matplotlib

可以用下面的命令检查安装是否完整:

python -c "import cyipopt, pockit; from pockit.optimizer import ipopt, scipy; print('Pockit is ready')"

如果已经有合适的 Conda 环境,直接在该环境中安装即可:

conda install -c conda-forge pockit-optimal-control

备选:PyPI

如果当前平台无法使用 conda,可以在虚拟环境中从 PyPI 安装:

python -m venv .venv
# Windows: .venv\Scripts\activate
# Linux/macOS: source .venv/bin/activate
python -m pip install --upgrade pip
python -m pip install pockit-optimal-control

PyPI 的基础安装包含 SciPy 后端。如需运行绘图示例,请安装 examples 可选依赖组:

python -m pip install "pockit-optimal-control[examples]"

如果希望在 PyPI 安装的基础上使用 Ipopt,系统中还必须有兼容的原生 Ipopt 库。 除非确实需要自行定制 Ipopt,否则建议改用上面的 conda-forge 安装方式。其他情况 可参考 Ipopt 手动安装指南

从源码安装

开发 Pockit 时,请克隆仓库并采用可编辑安装(editable install),不要把 pockit/ 文件夹直接复制到其他项目中:

git clone https://github.com/zouyilin2000/pockit.git
cd pockit
python -m pip install -e ".[examples]"
python -m pip install pytest
python -m pytest -q

不同求解器的适用场景见优化器选择