add docstring improve CI

Author: StefanThoene

.github/workflows/ci_cd.yml

@@ -89,7 +89,7 @@ jobs:
         env:
           ANSYSLMD_LICENSE_FILE: 1055@${{ secrets.LICENSE_SERVER }}
         run: |
-          docker run --detach --name speos-rpc -p 50098:50098 -e SPEOS_MAX_MESSAGE_LENGTH=268435456 -e SPEOS_LOG_LEVEL=2 -e ANSYSLMD_LICENSE_FILE=${{ env.ANSYSLMD_LICENSE_FILE }} -v "${{ github.workspace }}/tests/assets:/app/assets" --entrypoint /app/SpeosRPC_Server.x ghcr.io/ansys/speos-rpc:dev
+          docker run --detach --name speos-rpc -p 50098:50098 -e SPEOS_LOG_LEVEL=2 -e ANSYSLMD_LICENSE_FILE=${{ env.ANSYSLMD_LICENSE_FILE }} -v "${{ github.workspace }}/tests/assets:/app/assets" --entrypoint /app/SpeosRPC_Server.x ghcr.io/ansys/speos-rpc:dev
       - name: "Run Ansys documentation building action"
         uses: ansys/actions/doc-build@b46bf28ca54671fcb1444fb119533ecd113e98f0 # v9.0.11
         with:

src/ansys/speos/core/kernel/client.py

@@ -122,6 +122,9 @@ class SpeosClient:
     channel : ~grpc.Channel, optional
         gRPC channel for server communication.
         By default, ``None``.
+    message_size: int
+        Maximum Message size of a newly generated channel
+        By default, ``MAX_CLIENT_MESSAGE_SIZE``.
     remote_instance : ansys.platform.instancemanagement.Instance
         The corresponding remote instance when the Speos Service
         is launched through PyPIM. This instance will be deleted when calling

src/ansys/speos/core/launcher.py

@@ -130,6 +130,9 @@ def launch_local_speos_rpc_server(
     server_message_size : int
         Maximum message length value accepted by the Speos RPC server,
         By default, value stored in environment variable SPEOS_MAX_MESSAGE_LENGTH or 268 435 456.
+    client_message_size: int
+        Maximum Message size of a newly generated channel
+        By default, ``MAX_CLIENT_MESSAGE_SIZE``.
     logfile_loc : str
         location for the logfile to be created in.
     log_level : int

src/ansys/speos/core/speos.py

@@ -58,6 +58,9 @@ class Speos:
     channel : ~grpc.Channel, optional
         gRPC channel for server communication.
         By default, ``None``.
+    message_size: int
+        Maximum Message size of a newly generated channel
+        By default, ``MAX_CLIENT_MESSAGE_SIZE``.
     remote_instance : ansys.platform.instancemanagement.Instance
         The corresponding remote instance when the Speos Service
         is launched through PyPIM. This instance will be deleted when calling