Skip to content

Commit 295a60d

Browse files
PProfiziJennaPaikowsky
PProfizi
and
JennaPaikowsky
authored
Update compatibility and dependencies for 0.10.0 (#1218)
* Update README.md for 0.10.0 * Update troubleshooting.rst for 0.10.0 * Update README.md for 0.10.0 * Update install.rst for 0.10.0 * Update dependencies.rst for 0.10.0 * Update compatibility.rst for 0.10.0 * Fix Vale errors * Apply suggestions from code review Co-authored-by: JennaPaikowsky <[email protected]> --------- Co-authored-by: JennaPaikowsky <[email protected]>
1 parent 9db2cf5 commit 295a60d

File tree

6 files changed

+128
-59
lines changed

6 files changed

+128
-59
lines changed

‎README.md‎

Lines changed: 17 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@ For the compatibility between PyDPF-Core and Ansys, see
7777
[Compatibility](https://dpf.docs.pyansys.com/version/stable/getting_started/compatibility.html) in
7878
the PyDPF-Core documentation.
7979

80-
To use PyDPF-Core with the ``ansys-dpf-server`` server package or with Ansys 2021 R2 or later,
80+
To use PyDPF-Core with the ``ansys-dpf-server`` server package or with Ansys 2022 R2 or later,
8181
install the latest version with this command:
8282

8383
```con
@@ -93,11 +93,25 @@ To install PyDPF-Core with its optional plotting functionalities, use this comma
9393

9494
For more information on PyDPF-Core plotting capabilities, see [Plot](https://dpf.docs.pyansys.com/version/stable/user_guide/plotting.html) in the PyDPF-Core documentation.
9595

96-
To use PyDPF-Core with Ansys 2021 R1, install the latest version
96+
To use PyDPF-Core with Ansys 2022 R1, install the latest compatible version
9797
with this command:
9898

9999
```con
100-
pip install ansys-dpf-core<0.3.0
100+
pip install ansys-dpf-core<0.10.0
101+
```
102+
103+
To use PyDPF-Core with Ansys 2021 R2, install the latest compatible version
104+
with this command:
105+
106+
```con
107+
pip install ansys-grpc-dpf<0.4.0; pip install ansys-dpf-core<0.10.0
108+
```
109+
110+
To use PyDPF-Core with Ansys 2021 R1, install the latest compatible version
111+
with this command:
112+
113+
```con
114+
pip install ansys-grpc-dpf<0.3.0; pip install ansys-dpf-core<0.3.0
101115
```
102116

103117
### Brief demo

‎docs/source/getting_started/compatibility.rst‎

Lines changed: 72 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -15,84 +15,115 @@ Client-server
1515

1616
The DPF server version depends on your installed Ansys version.
1717
The following table shows client-server compatibility for supported
18-
Ansys versions. With Ansys 2021 R2 and later, you can use PyDPF-Core
19-
version 0.3.0 or later. With Ansys 2021 R1, you must use a PyDPF-Core 0.2
18+
Ansys versions. With Ansys 2022 R2 and later, you can use PyDPF-Core ``0.10`` and later.
19+
With Ansys 2021 R2 and 2022 R1, you can use PyDPF-Core
20+
version ``0.3`` up to ``0.9``. With Ansys 2021 R1, you must use a PyDPF-Core ``0.2``
2021
version.
2122

2223
As new features are developed, every attempt is made to ensure backward
23-
compatibility from the client to the server. Backward compatibility is ensured for
24+
compatibility from the client to the server. Backward compatibility is generally ensured for
2425
the 4 latest Ansys versions. For example, ansys-dpf-core module with 0.8.0 version has been
2526
developed for Ansys 2023 R2 pre1 release, for 2023 R2 Ansys version. It is compatible with
2627
2023 R2, 2023 R1, 2022 R2 and 2022 R1 Ansys versions.
2728

29+
Starting with version ``0.10`` of ``ansys-dpf-core``, the packages ``ansys-dpf-gate``,
30+
``ansys-dpf-gatebin`` and ``ansys-grpc-dpf`` are no longer dependencies and are directly integrated
31+
within ``ansys-dpf-core`` as modules. This introduced a breaking change to simplify installation
32+
and prevent synchronization issues between the PyDPF libraries, requiring to drop support for Ansys
33+
previous to 2022 R2.
34+
2835
**Ansys strongly encourages you to use the latest packages available**, as far they are compatible
29-
with the Server version you want to use. Using Ansys 2022 R2, if ansys-dpf-core module with
30-
0.8.0 version is the latest available package, it should be used.
36+
with the Server version you want to run. Considering Ansys 2023 R1 for example, if ansys-dpf-core
37+
module with 0.10.0 version is the latest available compatible package, it should be used.
3138

32-
The `ansys.grpc.dpf <https://pypi.org/project/ansys-grpc-dpf/>`_ package
33-
should also be synchronized with the server version.
39+
For ``ansys-dpf-core<0.10``, the `ansys.grpc.dpf <https://pypi.org/project/ansys-grpc-dpf/>`_
40+
package should also be synchronized with the server version.
3441

3542
.. list-table:: Client-server compatibility
3643
:widths: 20 20 20 20 20
3744
:header-rows: 1
3845

3946
* - Server version
47+
- ``ansys.dpf.core`` Python module version
48+
- ``ansys.grpc.dpf`` Python module version
4049
- ``ansys.dpf.gatebin`` binaries Python module version
4150
- ``ansys.dpf.gate`` Python module version
42-
- ``ansys.grpc.dpf`` Python module version
43-
- ``ansys.dpf.core`` Python module version
4451
* - 7.0 (Ansys 2024 R1 pre0)
45-
- 0.4.1 and later
46-
- 0.4.1 and later
47-
- 0.8.1 and later
48-
- 0.9.0 and later
52+
- | 0.10.0 and later
53+
| 0.9.0
54+
- | None
55+
| 0.8.1
56+
- | None
57+
| 0.4.1
58+
- | None
59+
| 0.4.1
4960
* - 6.2 (Ansys 2023 R2)
50-
- 0.3.1 and later
51-
- 0.3.1 and later
52-
- 0.7.1 and later
53-
- 0.8.0 and later
61+
- | 0.10.0 and later
62+
| 0.8.0 and later
63+
- | None
64+
| 0.7.1 and later
65+
- | None
66+
| 0.3.1 and later
67+
- | None
68+
| 0.3.1 and later
5469
* - 6.1 (Ansys 2023 R2 pre1)
55-
- 0.3.1 and later
56-
- 0.3.1 and later
57-
- 0.7.1 and later
58-
- 0.8.0 and later
70+
- | 0.10.0 and later
71+
| 0.8.0 and later
72+
- | None
73+
| 0.7.1 and later
74+
- | None
75+
| 0.3.1 and later
76+
- | None
77+
| 0.3.1 and later
5978
* - 6.0 (Ansys 2023 R2 pre0)
60-
- 0.3.0 and later
61-
- 0.3.0 and later
62-
- 0.7.0 and later
63-
- 0.7.0 and later
79+
- | 0.10.0 and later
80+
| 0.7.0 and later
81+
- | None
82+
| 0.7.0 and later
83+
- | None
84+
| 0.3.0 and later
85+
- | None
86+
| 0.3.0 and later
6487
* - 5.0 (Ansys 2023 R1)
65-
- 0.2.0 and later
66-
- 0.2.0 and later
67-
- 0.6.0 and later
68-
- 0.6.0 and later
88+
- | 0.10.0 and later
89+
| 0.6.0 and later
90+
- | None
91+
| 0.6.0 and later
92+
- | None
93+
| 0.2.0 and later
94+
- | None
95+
| 0.2.0 and later
6996
* - 4.0 (Ansys 2022 R2)
70-
- 0.1.0 and later
71-
- 0.1.0 and later
72-
- 0.5.0 and later
73-
- 0.5.0 and later
97+
- | 0.10.0 and later
98+
| 0.5.0 and later
99+
- | None
100+
| 0.5.0 and later
101+
- | None
102+
| 0.1.0 and later
103+
- | None
104+
| 0.1.0 and later
74105
* - 3.0 (Ansys 2022 R1)
106+
- 0.4.0 to 0.9.0
107+
- 0.4.0
75108
- None
76109
- None
77-
- 0.4.0
78-
- 0.4.0 and later
79110
* - 2.0 (Ansys 2021 R2)
111+
- 0.3.0 and later**
112+
- 0.3.0
80113
- None
81114
- None
82-
- 0.3.0
83-
- 0.3.0 and later**
84115
* - 1.0 (Ansys 2021 R1)
116+
- 0.2.*
117+
- 0.2.2
85118
- None
86119
- None
87-
- 0.2.2
88-
- 0.2.*
89120

90-
(** Compatibility of DPF 2.0 with ansys-dpf-core 0.5.0 and later is assumed but no longer certified.)
121+
(** Compatibility of DPF 2.0 with ansys-dpf-core 0.5.0 to 0.9.0 is assumed but not certified.)
91122

92123
Update Python environment
93124
-------------------------
94125

95-
When moving from one Ansys release to another, you must update the ``ansys-dpf-core`` package and its dependencies.
126+
When moving from one Ansys release to another, you must update the ``ansys-dpf-core`` package.
96127
To get the latest version of the ``ansys-dpf-core`` package, use this command:
97128

98129
.. code::

‎docs/source/getting_started/dependencies.rst‎

Lines changed: 18 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -8,20 +8,28 @@ Package dependencies
88
--------------------
99

1010
Dependencies for the ``ansys-dpf-core`` package are automatically checked when the
11-
package is installed. Package dependencies follow:
11+
package is installed. Package dependencies are:
12+
13+
- `google-api-python-client <https://pypi.org/project/google-api-python-client/>`_
14+
- `grpcio <https://pypi.org/project/grpcio/>`_
15+
- `importlib-metadata <https://pypi.org/project/importlib-metadata/>`_
16+
- `numpy <https://pypi.org/project/numpy/>`_
17+
- `packaging <https://pypi.org/project/packaging/>`_
18+
- `protobuf <https://pypi.org/project/protobuf/>`_
19+
- `psutil <https://pypi.org/project/psutil/>`_
20+
- `setuptools <https://pypi.org/project/setuptools/>`_
21+
- `tqdm <https://pypi.org/project/tqdm/>`_
22+
23+
For ``ansys-dpf-core<0.10.0``, the ``ansys.dpf.gate``, ``ansys.dpf.gatebin`` and ``ansys.grpc.dpf``
24+
modules are not included and are dependencies:
1225

1326
- `ansys.dpf.gate <https://pypi.org/project/ansys-dpf-gate/>`_, which is the gate
1427
to the DPF C API or Python gRPC API. The gate depends on the server configuration:
28+
- `ansys.grpc.dpf <https://pypi.org/project/ansys-grpc-dpf/>`_ is the gRPC code
29+
generated from protobuf files and is a dependency of ``ansys-dpf-gate``.
30+
- `ansys.dpf.gatebin <https://pypi.org/project/ansys-dpf-gatebin/>`_ is the
31+
operating system-specific binaries with DPF C APIs and is a dependency of ``ansys-dpf-gate``.
1532

16-
- `ansys.grpc.dpf <https://pypi.org/project/ansys-grpc-dpf/>`_ is the gRPC code
17-
generated from protobuf files.
18-
- `ansys.dpf.gatebin <https://pypi.org/project/ansys-dpf-gatebin/>`_ is the
19-
operating system-specific binaries with DPF C APIs.
20-
21-
- `psutil <https://pypi.org/project/psutil/>`_
22-
- `tqdm <https://pypi.org/project/tqdm/>`_
23-
- `packaging <https://pypi.org/project/packaging/>`_
24-
- `numpy <https://pypi.org/project/numpy/>`_
2533

2634
Optional dependencies
2735
~~~~~~~~~~~~~~~~~~~~~

‎docs/source/getting_started/install.rst‎

Lines changed: 17 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Install using ``pip``
99

1010
The standard package installer for Python is `pip <https://pypi.org/project/pip/>`_.
1111

12-
To use PyDPF-Core with Ansys 2021 R2 or later, install the latest version
12+
To use PyDPF-Core with Ansys 2022 R2 or later, install the latest version
1313
with this command:
1414

1515
.. code::
@@ -25,12 +25,26 @@ To install PyDPF-Core with its optional plotting functionalities, use:
2525
2626
For more information about PyDPF-Core plotting capabilities, see :ref:`user_guide_plotting`.
2727

28-
To use PyDPF-Core with Ansys 2021 R1, install the latest version
28+
To use PyDPF-Core with Ansys 2022 R1, install the latest compatible version
2929
with this command:
3030

3131
.. code::
3232
33-
pip install ansys-dpf-core<0.3.0
33+
pip install ansys-dpf-core<0.10.0
34+
35+
To use PyDPF-Core with Ansys 2021 R2, install the latest compatible version
36+
with this command:
37+
38+
.. code::
39+
40+
pip install ansys-grpc-dpf<0.4.0; pip install ansys-dpf-core<0.10.0
41+
42+
To use PyDPF-Core with Ansys 2021 R1, install the latest compatible version
43+
with this command:
44+
45+
.. code::
46+
47+
pip install ansys-grpc-dpf<0.3.0; pip install ansys-dpf-core<0.3.0
3448
3549
3650
Install without internet

‎docs/source/user_guide/troubleshooting.rst‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,14 +28,14 @@ on the network.
2828

2929
Import the ``pydpf-core`` package
3030
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
31-
Assume that you are importing the ``pydpf-core`` package:
31+
Assume that you are importing the ``PyDPF-Core`` package:
3232

3333
.. code-block:: default
3434
3535
from ansys.dpf import core as dpf
3636
3737
If an error lists missing modules, see :ref:`ref_compatibility`.
38-
The `ansys.grpc.dpf <https://pypi.org/project/ansys-grpc-dpf/>`_ module
38+
For ``PyDPF-Core``<0.10.0, the `ansys.grpc.dpf <https://pypi.org/project/ansys-grpc-dpf/>`_ module
3939
should always be synchronized with its server version.
4040
4141
Model issues

‎docs/styles/Vocab/ANSYS/accept.txt‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ Gaussian
1111
getters
1212
gltf
1313
GLTF
14+
grpcio
1415
hexa
1516
IronPython
1617
matplotlib
@@ -33,6 +34,7 @@ Reusability
3334
Rz
3435
scopings
3536
serializer
37+
setuptools
3638
substep
3739
tqdm
3840
von

0 commit comments

Comments
 (0)