.. _installation:

************
Installation
************

Install using ``pip``
---------------------

Python 的标准软件包安装程序是 `pip <https://pypi.org/project/pip/>`_ 。

要在 Ansys 2022 R2 或更高版本中使用 PyDPF-Core，请使用此命令安装最新版本：

.. code::

   pip install ansys-dpf-core

PyDPF-Core 的绘图功能需要安装 `PyVista <https://pyvista.org/>`_。要安装 PyDPF-Core 及其可选的绘图功能，请使用

.. code::

   pip install ansys-dpf-core[plotting]

有关 PyDPF-Core 绘图功能的更多信息，请参阅 :ref:`user_guide_plotting` 。

要在 Ansys 2022 R1 中使用 PyDPF-Core，请使用此命令安装最新的兼容版本：

.. code::

   pip install ansys-dpf-core<0.10.0

要在 Ansys 2021 R2 中使用 PyDPF-Core，请使用此命令安装最新的兼容版本：

.. code::

   pip install ansys-grpc-dpf<0.4.0; pip install ansys-dpf-core<0.10.0

要在 Ansys 2021 R1 中使用 PyDPF-Core，请使用此命令安装最新的兼容版本：

.. code::

   pip install ansys-grpc-dpf<0.3.0; pip install ansys-dpf-core<0.3.0


Install without internet
------------------------

如果由于网络隔离的原因，无法使用 ``pip`` 在主机上安装 PyDPF-Core，请从 `GitHub <https://github.com/ansys/pydpf-core/releases/latest>`_ 上
最新 PyDPF-Core 发布的 assets 部分，下载与您的平台和 Python 解释器版本相对应的最新 PyDPF-Core 的 wheelhouse。

wheelhouse是一个 ZIP 文件，包含 PyDPF-Core 运行所需的所有软件包的 Python wheels。要使用下载的 wheelhouse 安装 PyDPF-Core，请将 wheelhouse 解压缩到本地目录，然后在本地目录中使用以下命令：

.. code::

   pip install --no-index --find-links=. ansys-dpf-core

请注意 PyDPF-Core wheelhouses 不包含可选的绘图依赖
为实现绘图功能，还需下载与您的平台和 Python 解释器版本相对应的 `PyVista <https://pypi.org/project/pyvista/#files>`_ 
和 `matplotlib <https://pypi.org/project/matplotlib/#files>`_ 的 wheels，然后将它们放在之前的同一本地目录中，并运行上述命令。

Install in development mode
---------------------------

如果你想编辑 PyDPF-Core 并为其做出贡献，请克隆该版本库，并使用 ``pip`` 和 ``-e`` 开发标志安装它：

.. include:: ../pydpf-core_clone_install.rst


.. _target_to_install_with_plotting_capabilities:


Check the installation
----------------------

运行以下 Python 代码来验证 PyDPF-Core 的安装：

.. code::

   from ansys.dpf.core import Model
   from ansys.dpf.core import examples
   model = Model(examples.find_simple_bar())
   print(model)