Skip to content

Commit 7bac151

Browse files
authored
add client server compatibility info in doc (#94)
1 parent 704a00c commit 7bac151

File tree

1 file changed

+32
-4
lines changed

1 file changed

+32
-4
lines changed

docs/source/getting_started/index.rst

Lines changed: 32 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ Installation
2727

2828

2929
Tryout Installation
30-
~~~~~~~~~~~~~~~~
30+
~~~~~~~~~~~~~~~~~~~
3131

3232
For a quick tryout installation, use:
3333

@@ -92,9 +92,9 @@ Optional Dependencies
9292

9393
Optional package dependencies can be installed for specific usage:
9494

95-
- - `Matplotlib <https://pypi.org/project/matplotlib/>`_ for chart plotting
96-
- - `PyVista <https://pypi.org/project/pyvista/>`_ for 3D plotting
97-
- - `Scooby <https://pypi.org/project/scooby//>`_ for dependency reports
95+
- `Matplotlib <https://pypi.org/project/matplotlib/>`_ for chart plotting
96+
- `PyVista <https://pypi.org/project/pyvista/>`_ for 3D plotting
97+
- `Scooby <https://pypi.org/project/scooby//>`_ for dependency reports
9898

9999

100100
Compatibility
@@ -105,3 +105,31 @@ more information, see `Ansys Platform Support <https://www.ansys.com/solutions/s
105105
Other platforms may be supported by using DPF within a
106106
containerization ecosystem such as Docker or Kubernetes.
107107
For more information, see :ref:`docker`.
108+
109+
***************************
110+
Client Server Compatibility
111+
***************************
112+
113+
The `ansys.grpc.dpf <https://pypi.org/project/ansys-grpc-dpf/>`_ module should be synchronized
114+
with the server version as shown here:
115+
116+
.. list-table:: Client-Server Compatibility
117+
:widths: 35 35 35
118+
:header-rows: 1
119+
120+
* - Ans.Dpf.Grpc.exe server version
121+
- ansys.grpc.dpf python module version
122+
- ansys.dpf.core python module version
123+
* - 2.0 (Ansys 2021R2)
124+
- 0.3.0
125+
- >=0.3.0
126+
* - 1.0 (Ansys 2021R1)
127+
- 0.2.2
128+
- 0.2.*
129+
130+
131+
Future development will try to ensure backward compatibilty from the client to the server.
132+
133+
134+
To start a server with Ans.Dpf.Grpc.bat or Ans.Dpf.Grpc.sh (used in the `start_local_server` function),
135+
please make sure that the environment variable `AWP_ROOT{VER}` with (VER=212, 221, ...) is set.

0 commit comments

Comments
 (0)