安装

快速开始

从QuTiP 4.6版本开始，您应该能够通过标准方式获得一个可用的QuTiP版本。

pip install qutip

不建议直接在系统Python环境中安装任何包；考虑使用pip或conda虚拟环境来保持操作系统空间的清洁，并更好地控制Python和其他包的版本。

除非此命令未起作用，否则您无需担心本页其余部分的详细信息，但也请阅读下一部分以了解可选依赖项的列表。本页的其余部分涵盖了直接从conda安装、从源代码安装以及在Windows上工作时的其他注意事项。

一般要求

QuTiP 依赖于几个用于 Python 编程语言中科学计算的开源库。以下是当前所需的包：

包	版本	详情
Python	3.9+	4.7版本需要3.6+
NumPy	1.22+ <2.0	4.7版本需要1.16+
SciPy	1.8+	4.7版本需要1.0+

此外，还有一些可选包提供了额外的功能：

包	版本	详情
`matplotlib`	1.2.1+	所有可视化任务所需。
`cython` `setuptools` `filelock`	0.29.20+	用于编译一些时间相关的哈密顿量。Cython需要一个可用的C++编译器。
`cvxpy`	1.0+	需要计算钻石范数。
`pytest`, `pytest-rerunfailures`	5.3+	用于运行测试套件。
LaTeX	TeXLive 2009+	如果在matplotlib图形中使用LaTeX，或者在IPython中绘制漂亮的电路图，则需要。
`loky`, `mpi4py`		额外的并行映射后端。
`tqdm`		额外的进度条后端。

此外，还有一些额外的包虽然不是依赖项，但可能会提供更好的编程体验。 IPython 提供了一个改进的基于文本的 Python 解释器，它比默认解释器功能更丰富，并在终端中运行。如果您更喜欢图形化的设置，Jupyter 提供了一个笔记本风格的界面，可以将代码和数学笔记混合在一起。或者，Spyder 是一个免费的 Python 集成开发环境，具有多个用于调试代码的出色功能。 QuTiP 会检测是否在这些更丰富的环境中使用，并且各种输出将具有增强的格式。

使用conda安装

如果您已经设置好了conda环境，并且有conda-forge频道可用，那么您可以使用以下命令安装QuTiP：

conda install qutip

这将安装最小的一组依赖项，但不包括任何可选包。

添加conda-forge频道

要从conda安装QuTiP，您需要添加conda-forge频道。以下命令以最低优先级添加此频道，因此conda仍会尝试正常安装所有其他软件包：

conda config --append channels conda-forge

如果您以后想要更改频道的顺序，可以手动编辑您的.condarc（用户主文件夹）文件，但建议将defaults保持为最高优先级。

新的conda环境

默认的Anaconda环境已经安装了运行QuTiP所需的所有Python包，因此您只需要添加conda-forge频道，然后安装该包。如果您只安装了Miniconda，或者您想要一个完全干净的虚拟环境来安装QuTiP，conda包管理器提供了一种方便的方法来实现这一点。

要创建一个名为 qutip-env 的 conda 环境用于 QuTiP：

conda create -n qutip-env python qutip

这将自动安装所有必要的包，而不安装任何可选包。您可以通过运行以下命令来激活新环境

conda activate qutip-env

你也可以使用conda install安装任何你想要的额外可选包，例如matplotlib、ipython或jupyter。

从源代码安装

QuTiP的官方版本可以从项目网页的下载部分获取，最新源代码可在我们的GitHub仓库中找到。通常我们建议用户使用QuTiP的最新稳定版本，但如果您有兴趣帮助我们进行开发或希望提交错误修复，请使用GitHub仓库中的最新开发版本。

您可以使用Python推荐的PEP 517程序从源代码安装，或者如果您想要更多的控制权或拥有开发版本，您可以使用使用setuptools的低级构建程序。

PEP 517 源码构建

从源代码构建 QuTiP 的最简单方法是使用与 PEP-517 兼容的构建器，例如在 pip 上可用的 build 包。这些工具会自动为您安装所有构建依赖项，之后的 pip 安装步骤将安装最小的运行时依赖项。您可以通过以下方式实现（例如）：

pip install build
python -m build <path to qutip>
pip install <path to qutip>/dist/qutip-<version>.whl

第一个命令安装了参考的PEP-517构建工具，第二个命令执行构建，第三个命令使用pip来安装构建的包。你需要将 to qutip>替换为QuTiP源代码的实际路径。字符串将取决于QuTiP的版本、Python的版本以及你的操作系统。它看起来可能像4.6.0-cp39-cp39-manylinux1_x86_64，但在dist/目录中应该只有一个.whl文件，那就是正确的文件。

直接Setuptools源代码构建

这是对安装过程拥有最大控制权的方法，但它也是最容易出错的，除非你知道自己在做什么，否则不推荐使用。你首先需要安装所有的运行时依赖项。最新的需求将列在pyproject.toml文件中，位于build-system.requires键下。截至5.0.0版本，构建需求可以通过以下方式安装：

pip install setuptools wheel packaging cython 'numpy<2.0.0' scipy

或者如果你更喜欢，可以使用conda进行类似操作。你还需要在系统上安装一个可用的C++编译器。如果你使用的是Linux或macOS，这可能已经为你完成了，但如果你使用的是Windows操作系统，请参阅Windows安装部分。

要从源代码安装QuTiP，请运行：

pip install .

如果您希望为QuTiP项目做出贡献，那么您需要创建自己的QuTiP git仓库的分支，将其克隆到本地文件夹，并使用以下命令将其安装到您的Python环境中：

python setup.py develop

当您在此环境中执行import qutip时，您将从本地分支加载代码，使您能够编辑Python文件并在重新启动Python解释器时立即使用更改，而无需重新构建包。请注意，如果您更改了任何Cython文件，您将需要重新运行构建命令。

您不应该需要使用sudo（或其他超级用户权限）来安装到个人虚拟环境中；如果您觉得需要这样做，很可能是因为您正在安装到系统Python环境中。

在Windows上安装

与其他操作系统一样，最简单的方法是使用pip install qutip，或者使用上面描述的conda程序。如果你想从源代码构建或使用Cython进行运行时编译，你需要有一个可用的C++编译器。

你可以从微软下载Visual Studio IDE，它有一个免费的社区版，包含足够的C++编译器。这是在Windows上推荐的编译器工具链。安装时，请确保选择以下组件：

Windows “X” SDK（其中“X”代表您的版本：7/8/8.1/10）
Visual Studio C++ 构建工具

然后您可以按照从源代码安装部分正常进行。

重要

为了防止PATH环境变量不包含编译器及相关库的问题，建议使用Visual Studio安装文件夹中的开发者命令提示符，而不是内置的命令提示符。

Visual Studio 社区版大约需要 10GB 的磁盘空间。如果这对您来说是不可接受的，您也可以选择安装仅构建工具和必要的 SDK，这样可以节省大约 2GB 的空间。

验证安装

QuTiP 包含一系列内置测试脚本，用于验证安装是否成功。要运行这套测试脚本，您还必须安装 pytest 测试库。安装 QuTiP 后，离开安装目录并调用：

pytest qutip/qutip/tests

这将需要10到30分钟，具体取决于您的计算机。最后，测试报告应显示成功；有些测试被跳过，有些被标记为“xfail”（以黄色显示）是正常的。跳过的测试可能是无法在您的操作系统上运行的测试，或者是您未安装依赖项的可选组件的测试。如果出现任何失败或错误，请检查您是否已安装所有必需的模块。请参阅下一节，了解如何检查QuTiP依赖项的安装版本。如果这些测试仍然失败，请前往QuTiP讨论板或GitHub问题页面，并发布一条消息详细说明您的具体问题。

检查版本信息

QuTiP 包含一个“about”函数，用于查看有关 QuTiP 和系统上安装的重要依赖项的信息。要查看此信息：

import qutip
qutip.about()