Skip to content

Commit d85abea

Browse files
anslpaPipKat
andauthored
Documentation: Doc/update python environment if getting new Ansys version (#652)
* Update compatibility page * Add get latest get specific * Update docs/source/getting_started/compatibility.rst Co-authored-by: Kathy Pippert <[email protected]> * Update with comments * Last line Co-authored-by: Kathy Pippert <[email protected]>
1 parent bd4a811 commit d85abea

File tree

1 file changed

+18
-1
lines changed

1 file changed

+18
-1
lines changed

docs/source/getting_started/compatibility.rst

Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -67,6 +67,23 @@ should also be synchronized with the server version.
6767

6868
(** compatibility of DPF 2.0 with ansys-dpf-core 0.5.0 and later is assumed but no longer certified)
6969

70+
Updating Python environment
71+
---------------------------
72+
73+
When moving from one Ansys release to another, you must update the ``ansys-dpf-core`` package and its dependencies.
74+
To get the latest version of the ``ansys-dpf-core`` package, use this code:
75+
76+
.. code::
77+
78+
pip install --upgrade --force-reinstall ansys-dpf-core
79+
80+
To get a specific version of the ``ansys-dpf-core`` package, such as 0.7.0, use this code:
81+
82+
.. code::
83+
84+
pip install --force-reinstall ansys-dpf-core==0.7.0
85+
86+
7087
Environment variable
7188
--------------------
7289

@@ -75,4 +92,4 @@ The ``start_local_server`` method uses the ``Ans.Dpf.Grpc.bat`` file or
7592
environment variable is set to your installed Ansys version. For example, if Ansys
7693
2022 R2 is installed, ensure that the ``AWP_ROOT222`` environment
7794
variable is set to the path for this Ansys installation.
78-
95+

0 commit comments

Comments
 (0)