ansys-systemcoupling-core 0.7.0__py3-none-any.whl → 0.9.0__py3-none-any.whl

ansys/systemcoupling/core/client/services/process.py

@@ -1,4 +1,4 @@
-# Copyright (C) 2023 - 2024 ANSYS, Inc. and/or its affiliates.
+# Copyright (C) 2023 - 2025 ANSYS, Inc. and/or its affiliates.
 # SPDX-License-Identifier: MIT
 #
 #

ansys/systemcoupling/core/client/services/solution.py

@@ -1,4 +1,4 @@
-# Copyright (C) 2023 - 2024 ANSYS, Inc. and/or its affiliates.
+# Copyright (C) 2023 - 2025 ANSYS, Inc. and/or its affiliates.
 # SPDX-License-Identifier: MIT
 #
 #
@@ -20,11 +20,11 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 # SOFTWARE.
 
-import ansys.api.systemcoupling.v0.error_pb2 as syc_error_pb2
 import ansys.api.systemcoupling.v0.solution_pb2 as solution_pb2
 import ansys.api.systemcoupling.v0.solution_pb2_grpc as solution_pb2_grpc
 import grpc
-from grpc_status.rpc_status import from_call
+
+from ansys.systemcoupling.core.client.services.handle_rpc_error import handle_rpc_error
 
 
 class SolutionService:
@@ -36,16 +36,7 @@ class SolutionService:
         try:
             self.__stub.Solve(request)
         except grpc.RpcError as rpc_error:
-            status = from_call(rpc_error)
-            msg = f"Command execution failed: {status.message} (code={status.code})"
-            for detail in status.details:
-                if detail.Is(syc_error_pb2.ErrorDetails.DESCRIPTOR):
-                    info = syc_error_pb2.ErrorDetails()
-                    detail.Unpack(info)
-                    msg += (
-                        f"\n\nServer exception details:\n"
-                        f"{info.exception_classname}\n{info.stack_trace}"
-                    )
+            msg = handle_rpc_error(rpc_error)
             raise RuntimeError(msg) from None
 
     def interrupt(self, reason):

ansys/systemcoupling/core/client/syc_container.py

@@ -1,4 +1,4 @@
-# Copyright (C) 2023 - 2024 ANSYS, Inc. and/or its affiliates.
+# Copyright (C) 2023 - 2025 ANSYS, Inc. and/or its affiliates.
 # SPDX-License-Identifier: MIT
 #
 #
@@ -81,6 +81,9 @@ def start_container(
         idx = run_args.index("-p")
         run_args.insert(idx, container_user)
         run_args.insert(idx, "--user")
+        # Licensing can't log to default location if user is not the default 'root'
+        run_args.insert(idx, f"ANSYSLC_APPLOGDIR={mounted_to}")
+        run_args.insert(idx, "-e")
 
     license_server = os.getenv("ANSYSLMD_LICENSE_FILE")
     if license_server:

ansys/systemcoupling/core/client/syc_process.py

@@ -1,4 +1,4 @@
-# Copyright (C) 2023 - 2024 ANSYS, Inc. and/or its affiliates.
+# Copyright (C) 2023 - 2025 ANSYS, Inc. and/or its affiliates.
 # SPDX-License-Identifier: MIT
 #
 #
@@ -50,6 +50,10 @@ class SycProcess:  # pragma: no cover
             host, port, working_dir, version, **kwargs
         )
 
+    @property
+    def path_to_system_coupling(self) -> str:
+        return self.__process.args[0]
+
     def end(self):
         if self.__process and self.__process.poll() is None:
             pid = self.__process.pid

ansys/systemcoupling/core/client/variant.py

@@ -1,4 +1,4 @@
-# Copyright (C) 2023 - 2024 ANSYS, Inc. and/or its affiliates.
+# Copyright (C) 2023 - 2025 ANSYS, Inc. and/or its affiliates.
 # SPDX-License-Identifier: MIT
 #
 #

ansys/systemcoupling/core/examples/__init__.py

@@ -1,4 +1,4 @@
-# Copyright (C) 2023 - 2024 ANSYS, Inc. and/or its affiliates.
+# Copyright (C) 2023 - 2025 ANSYS, Inc. and/or its affiliates.
 # SPDX-License-Identifier: MIT
 #
 #

ansys/systemcoupling/core/examples/downloads.py

@@ -1,4 +1,4 @@
-# Copyright (C) 2023 - 2024 ANSYS, Inc. and/or its affiliates.
+# Copyright (C) 2023 - 2025 ANSYS, Inc. and/or its affiliates.
 # SPDX-License-Identifier: MIT
 #
 #

ansys/systemcoupling/core/native_api/__init__.py

@@ -1,4 +1,4 @@
-# Copyright (C) 2023 - 2024 ANSYS, Inc. and/or its affiliates.
+# Copyright (C) 2023 - 2025 ANSYS, Inc. and/or its affiliates.
 # SPDX-License-Identifier: MIT
 #
 #

ansys/systemcoupling/core/native_api/command_metadata.py

@@ -1,4 +1,4 @@
-# Copyright (C) 2023 - 2024 ANSYS, Inc. and/or its affiliates.
+# Copyright (C) 2023 - 2025 ANSYS, Inc. and/or its affiliates.
 # SPDX-License-Identifier: MIT
 #
 #

ansys/systemcoupling/core/native_api/datamodel_metadata.py

@@ -1,4 +1,4 @@
-# Copyright (C) 2023 - 2024 ANSYS, Inc. and/or its affiliates.
+# Copyright (C) 2023 - 2025 ANSYS, Inc. and/or its affiliates.
 # SPDX-License-Identifier: MIT
 #
 #

ansys/systemcoupling/core/native_api/meta_wrapper.py

@@ -1,4 +1,4 @@
-# Copyright (C) 2023 - 2024 ANSYS, Inc. and/or its affiliates.
+# Copyright (C) 2023 - 2025 ANSYS, Inc. and/or its affiliates.
 # SPDX-License-Identifier: MIT
 #
 #

ansys/systemcoupling/core/native_api/native_api.py

@@ -1,4 +1,4 @@
-# Copyright (C) 2023 - 2024 ANSYS, Inc. and/or its affiliates.
+# Copyright (C) 2023 - 2025 ANSYS, Inc. and/or its affiliates.
 # SPDX-License-Identifier: MIT
 #
 #

ansys/systemcoupling/core/native_api/object_path.py

@@ -1,4 +1,4 @@
-# Copyright (C) 2023 - 2024 ANSYS, Inc. and/or its affiliates.
+# Copyright (C) 2023 - 2025 ANSYS, Inc. and/or its affiliates.
 # SPDX-License-Identifier: MIT
 #
 #

ansys/systemcoupling/core/participant/manager.py

@@ -1,4 +1,4 @@
-# Copyright (C) 2023 - 2024 ANSYS, Inc. and/or its affiliates.
+# Copyright (C) 2023 - 2025 ANSYS, Inc. and/or its affiliates.
 # SPDX-License-Identifier: MIT
 #
 #

ansys/systemcoupling/core/participant/mapdl.py

@@ -1,4 +1,4 @@
-# Copyright (C) 2023 - 2024 ANSYS, Inc. and/or its affiliates.
+# Copyright (C) 2023 - 2025 ANSYS, Inc. and/or its affiliates.
 # SPDX-License-Identifier: MIT
 #
 #

ansys/systemcoupling/core/participant/protocol.py

@@ -1,4 +1,4 @@
-# Copyright (C) 2023 - 2024 ANSYS, Inc. and/or its affiliates.
+# Copyright (C) 2023 - 2025 ANSYS, Inc. and/or its affiliates.
 # SPDX-License-Identifier: MIT
 #
 #

ansys/systemcoupling/core/session.py

@@ -1,4 +1,4 @@
-# Copyright (C) 2023 - 2024 ANSYS, Inc. and/or its affiliates.
+# Copyright (C) 2023 - 2025 ANSYS, Inc. and/or its affiliates.
 # SPDX-License-Identifier: MIT
 #
 #
@@ -233,7 +233,8 @@ class Session:
 
         Reduces to a no-op if the System Coupling instance is not managed by PIM.
 
-        The remote file may optionally be given a different name from the local one.
+        The remote file may optionally be given a different name from the local one
+        and, if not, any directory prefix is stripped in the PIM case.
 
         Unless ``overwrite`` is ``True``, a ``FileExistsError`` will be raised if
         the remote file already exists.
@@ -246,8 +247,14 @@ class Session:
             remote file name - default is None
         overwrite: bool, optional
             whether to overwrite the remote file if it already exists - default is False
+
+        Returns
+        -------
+        str
+            The remote file name, excluding any directory prefix that might have been
+            present in ``file_name``.
         """
-        self.__rpc.upload_file(file_name, remote_file_name, overwrite)
+        return self.__rpc.upload_file(file_name, remote_file_name, overwrite)
 
     def download_file(
         self, file_name: str, local_file_dir: str = ".", overwrite: bool = False

ansys/systemcoupling/core/syc_version.py

@@ -1,4 +1,4 @@
-# Copyright (C) 2023 - 2024 ANSYS, Inc. and/or its affiliates.
+# Copyright (C) 2023 - 2025 ANSYS, Inc. and/or its affiliates.
 # SPDX-License-Identifier: MIT
 #
 #
@@ -24,8 +24,8 @@ from typing import Tuple
 
 # Define constants relating to the default/current version of System Coupling
 
-SYC_MAJOR_VERSION = 24
-SYC_MINOR_VERSION = 2
+SYC_MAJOR_VERSION = 25
+SYC_MINOR_VERSION = 1
 
 SYC_VERSION_CONCAT = f"{SYC_MAJOR_VERSION}{SYC_MINOR_VERSION}"
 SYC_VERSION_DOT = f"{SYC_MAJOR_VERSION}.{SYC_MINOR_VERSION}"

ansys/systemcoupling/core/util/file_transfer.py

@@ -1,4 +1,4 @@
-# Copyright (C) 2023 - 2024 ANSYS, Inc. and/or its affiliates.
+# Copyright (C) 2023 - 2025 ANSYS, Inc. and/or its affiliates.
 # SPDX-License-Identifier: MIT
 #
 #
@@ -29,15 +29,22 @@ from typing import Any, Optional, Protocol
 class FileTransferService(Protocol):  # pragma: no cover
     def upload_file(
         self, file_name: str, remote_file_name: Optional[str], overwrite: bool
-    ): ...
+    ) -> str: ...
 
     def download_file(self, file_name: str, local_file_dir: str, overwrite: bool): ...
 
 
 class NullFileTransferService(FileTransferService):  # pragma: no cover
-    """A do-nothing implementation of file upload/download service."""
+    """An essentially do-nothing implementation of file upload/download
+    service (with a minimal ``upload_file`` implementation)."""
 
-    ...
+    def upload_file(
+        self, file_name: str, remote_file_name: Optional[str], overwrite: bool
+    ) -> str:
+        # TODO - what should the behaviour be if remote_file_name is not None?
+        # It is not obvious that it would even make sense to call the Null
+        # implementation in that case.
+        return file_name
 
 
 class PimFileTransferService:  # pragma: no cover
@@ -70,11 +77,14 @@ class PimFileTransferService:  # pragma: no cover
 
     def upload_file(
         self, file_name: str, remote_file_name: Optional[str], overwrite: bool
-    ):
+    ) -> str:
         """Upload a file to the PIM-managed instance.
 
         The remote file may optionally be given a different name from the local one.
 
+        If the local file name includes a directory path, this is stripped and the
+        remote file is always placed in the "working directory" of the container.
+
         Unless ``overwrite`` is ``True``, a ``FileExistsError`` will be raised if
         the remote file already exists.
 
@@ -86,6 +96,12 @@ class PimFileTransferService:  # pragma: no cover
             remote file name (or use local file name if None)
         overwrite: bool
             whether to overwrite the remote file if it already exists
+
+        Returns
+        -------
+        str
+            The name assigned to the remote file name. If ``file_name`` included
+            a directory prefix, this is stripped from the returned name.
         """
         if os.path.isfile(file_name):
             remote_file_name = remote_file_name or os.path.basename(file_name)
@@ -105,6 +121,7 @@ class PimFileTransferService:  # pragma: no cover
             self.file_service.upload_file(file_name, remote_file_name)
             if delete_copy:
                 os.remove(file_name)
+            return remote_file_name
         else:
             raise FileNotFoundError(f"Local file {file_name} does not exist.")
 

ansys/systemcoupling/core/util/logging.py

@@ -1,4 +1,4 @@
-# Copyright (C) 2023 - 2024 ANSYS, Inc. and/or its affiliates.
+# Copyright (C) 2023 - 2025 ANSYS, Inc. and/or its affiliates.
 # SPDX-License-Identifier: MIT
 #
 #

ansys/systemcoupling/core/util/name_util.py

@@ -1,4 +1,4 @@
-# Copyright (C) 2023 - 2024 ANSYS, Inc. and/or its affiliates.
+# Copyright (C) 2023 - 2025 ANSYS, Inc. and/or its affiliates.
 # SPDX-License-Identifier: MIT
 #
 #

ansys/systemcoupling/core/util/pathstr.py

@@ -1,4 +1,4 @@
-# Copyright (C) 2023 - 2024 ANSYS, Inc. and/or its affiliates.
+# Copyright (C) 2023 - 2025 ANSYS, Inc. and/or its affiliates.
 # SPDX-License-Identifier: MIT
 #
 #

ansys/systemcoupling/core/util/state_keys.py

@@ -1,4 +1,4 @@
-# Copyright (C) 2023 - 2024 ANSYS, Inc. and/or its affiliates.
+# Copyright (C) 2023 - 2025 ANSYS, Inc. and/or its affiliates.
 # SPDX-License-Identifier: MIT
 #
 #

ansys/systemcoupling/core/util/yaml_helper.py

@@ -1,4 +1,4 @@
-# Copyright (C) 2023 - 2024 ANSYS, Inc. and/or its affiliates.
+# Copyright (C) 2023 - 2025 ANSYS, Inc. and/or its affiliates.
 # SPDX-License-Identifier: MIT
 #
 #

{ansys_systemcoupling_core-0.7.0.dist-info → ansys_systemcoupling_core-0.9.0.dist-info}/METADATA

@@ -1,10 +1,10 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: ansys-systemcoupling-core
-Version: 0.7.0
+Version: 0.9.0
 Summary: A Python wrapper for Ansys System Coupling.
 Author-email: "ANSYS, Inc." <pyansys.support@ansys.com>
 Maintainer-email: PyAnsys developers <pyansys.maintainers@ansys.com>
-Requires-Python: >=3.10,<3.13
+Requires-Python: >=3.10,<3.14
 Description-Content-Type: text/x-rst
 Classifier: Development Status :: 4 - Beta
 Classifier: Intended Audience :: Science/Research
@@ -16,10 +16,12 @@ Classifier: Operating System :: MacOS
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+License-File: LICENSE
 Requires-Dist: ansys-api-systemcoupling==0.2.0
 Requires-Dist: ansys-platform-instancemanagement~=1.0
 Requires-Dist: grpcio>=1.30.0
-Requires-Dist: grpcio-status>=1.30.0,<1.66.2
+Requires-Dist: grpcio-status>=1.30.0
 Requires-Dist: googleapis-common-protos>=1.50.0
 Requires-Dist: psutil>=5.7.0
 Requires-Dist: pyyaml
@@ -27,27 +29,26 @@ Requires-Dist: appdirs>=1.4.0
 Requires-Dist: importlib-metadata>=4.0
 Requires-Dist: matplotlib>=3.8.2
 Requires-Dist: build ; extra == "build"
-Requires-Dist: black==24.8.0 ; extra == "classesgen"
-Requires-Dist: isort==5.13.2 ; extra == "classesgen"
-Requires-Dist: ansys-sphinx-theme==1.0.7 ; extra == "doc"
+Requires-Dist: black==25.1.0 ; extra == "classesgen"
+Requires-Dist: isort==6.0.1 ; extra == "classesgen"
+Requires-Dist: ansys-sphinx-theme==1.3.2 ; extra == "doc"
 Requires-Dist: jupyter_sphinx==0.5.3 ; extra == "doc"
 Requires-Dist: matplotlib ; extra == "doc"
 Requires-Dist: numpydoc==1.8.0 ; extra == "doc"
-Requires-Dist: pypandoc==1.13 ; extra == "doc"
+Requires-Dist: pypandoc==1.15 ; extra == "doc"
 Requires-Dist: pytest-sphinx==0.6.3 ; extra == "doc"
-Requires-Dist: Sphinx==8.0.2 ; extra == "doc"
-Requires-Dist: sphinx-autobuild==2024.4.16 ; extra == "doc"
-Requires-Dist: sphinx-autodoc-typehints==2.3.0 ; extra == "doc"
+Requires-Dist: sphinx>=8.1.3 ; extra == "doc"
+Requires-Dist: sphinx-autobuild==2024.10.3 ; extra == "doc"
+Requires-Dist: sphinx-autodoc-typehints==3.1.0 ; extra == "doc"
 Requires-Dist: sphinx-copybutton==0.5.2 ; extra == "doc"
-Requires-Dist: sphinx-gallery==0.17.1 ; extra == "doc"
-Requires-Dist: sphinx-notfound-page==1.0.4 ; extra == "doc"
+Requires-Dist: sphinx-gallery==0.19.0 ; extra == "doc"
+Requires-Dist: sphinx-notfound-page==1.1.0 ; extra == "doc"
 Requires-Dist: sphinxcontrib-websupport==2.0.0 ; extra == "doc"
 Requires-Dist: sphinxemoji==0.3.1 ; extra == "doc"
-Requires-Dist: ansys-fluent-core==0.24.2 ; extra == "doc"
-Requires-Dist: ansys-dpf-core==0.13.0 ; extra == "doc"
-Requires-Dist: ansys-mapdl-core==0.68.4 ; extra == "doc"
-Requires-Dist: codespell==2.3.0 ; extra == "style"
-Requires-Dist: flake8==7.1.1 ; extra == "style"
+Requires-Dist: ansys-fluent-core==0.29.0 ; extra == "doc"
+Requires-Dist: ansys-mapdl-core==0.69.3 ; extra == "doc"
+Requires-Dist: codespell==2.4.1 ; extra == "style"
+Requires-Dist: flake8==7.1.2 ; extra == "style"
 Requires-Dist: pytest ; extra == "tests"
 Requires-Dist: pytest-cov ; extra == "tests"
 Requires-Dist: psutil>=5.7.0 ; extra == "tests"
@@ -136,16 +137,29 @@ in this order:
 
 * ``SYSC_ROOT``
 * ``AWP_ROOT``
-* ``AWP_ROOT242``
+* ``AWP_ROOT251``
 
 If a variable is set but does not refer to a valid installation, PySystemCoupling
 fails at that point, rather than attempting to use the next variable.
 
-In a standard user installation, the expectation is that only ``AWP_ROOT242`` is set.
+In a standard user installation, the expectation is that only ``AWP_ROOT251`` is set.
 
 (It is also possible to provide a different version number as an argument to the ``launch()``
 function. This will affect which ``AWP_ROOT<version>`` environment variable is examined.)
 
+   **WARNING**
+
+   There is an issue with the 25 R1 release of Ansys System Coupling that prevents it from
+   working in the gRPC server mode on which PySystemCoupling depends. A small patch
+   is available that may be applied to some of the Python files in the System Coupling
+   installation. This is provided in the ``patches/`` directory of this repository and will
+   allow System Coupling to work with the current release of PySystemCoupling.
+
+   Otherwise, PySystemCoupling should be used with an earlier release of System Coupling by
+   setting the environment variable ``AWP_ROOT`` or specifying the version number as an
+   argument to the ``launch()`` function.
+
+
 The System Coupling API is exposed to PySystemCoupling in two forms:
 
 * A documented interface based on concrete Python classes, following Pythonic conventions
@@ -157,7 +171,7 @@ familiar with System Coupling, adjusting to this form, which is the recommended
 However, if you are transitioning existing scripts, the native System Coupling API is made available
 as a convenience.
 
-.. note::
+   **Note**
 
    While most commands should work as expected via the native System Coupling API,
    no guarantees can be given because of the nature of how it is exposed.