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

ansys/systemcoupling/core/examples/downloads.py

@@ -32,6 +32,7 @@ Examples
 """
 
 import os
+import pathlib
 import shutil
 from typing import Optional
 import urllib.request
@@ -67,12 +68,19 @@ def _get_file_url(filename: str, directory: Optional[str] = None) -> str:
     return f"{root_url}/{filename}"
 
 
-def _retrieve_file(url: str, filename: str):
+def _retrieve_file(url: str, filename: str, download_to_cwd: bool = False):
+
+    name_to_return = lambda local_path: (
+        local_path if not download_to_cwd else pathlib.Path(local_path).name
+    )
+
+    download_target_dir = "." if download_to_cwd else pysyc.EXAMPLES_PATH
+
     # First check if file has already been downloaded
-    local_path = os.path.join(pysyc.EXAMPLES_PATH, os.path.basename(filename))
+    local_path = os.path.join(download_target_dir, os.path.basename(filename))
     local_path_no_zip = local_path.replace(".zip", "")
     if os.path.isfile(local_path_no_zip) or os.path.isdir(local_path_no_zip):
-        return local_path_no_zip, None
+        return name_to_return(local_path_no_zip), None
 
     # grab the correct url retriever
     urlretrieve = urllib.request.urlretrieve
@@ -83,30 +91,13 @@ def _retrieve_file(url: str, filename: str):
     if get_ext(local_path) in [".zip"]:
         _decompress(local_path)
         local_path = local_path[:-4]
-    return local_path, resp
-
-
-def _temp_get_file(filename: str, directory: Optional[str] = None):
-    example_dir = os.environ.get("PYSYC_EXAMPLE_DIR")
-    if example_dir is None:
-        raise Exception(
-            "PYSYC_EXAMPLE_DIR is not set. "
-            "(This is a temporary requirement during development.)"
-        )
-    local_path = os.path.join(pysyc.EXAMPLES_PATH, os.path.basename(filename))
-    local_path_no_zip = local_path.replace(".zip", "")
-    if os.path.isfile(local_path_no_zip) or os.path.isdir(local_path_no_zip):
-        return local_path_no_zip
-
-    file_path = os.path.join(example_dir, directory, filename)
-    shutil.copy(file_path, local_path)
-    if get_ext(local_path) in [".zip"]:
-        _decompress(local_path)
-        local_path = local_path[:-4]
-    return local_path
+    return name_to_return(local_path), resp
 
 
 def download_file(filename: str, directory: Optional[str] = None):
     url = _get_file_url(filename, directory)
-    return _retrieve_file(url, filename)[0]
-    # return _temp_get_file(filename, directory)
+    download_to_cwd = (
+        os.getenv("PYSYC_BUILD_SPHINX_GALLERY") == "1"
+        and os.getenv("SYC_LAUNCH_CONTAINER") == "1"
+    )
+    return _retrieve_file(url, filename, download_to_cwd)[0]

ansys/systemcoupling/core/participant/manager.py

@@ -24,6 +24,7 @@ import threading
 from typing import Dict, List, Tuple
 
 from ansys.systemcoupling.core.participant.protocol import ParticipantProtocol
+from ansys.systemcoupling.core.syc_version import compare_versions
 from ansys.systemcoupling.core.util.logging import LOG
 
 
@@ -54,10 +55,11 @@ class ParticipantManager:
         until more participant types support the protocol.
     """
 
-    def __init__(self, syc_session):
+    def __init__(self, syc_session, server_version: str):
         self.__participants: Dict[str, ParticipantProtocol] = {}
         self.__syc_session = syc_session
         self.__connection_lock = threading.Lock()
+        self.__server_version = server_version
         self.clear()
 
     def clear(self):
@@ -66,6 +68,11 @@ class ParticipantManager:
         self.__solve_exception = None
 
     def add_participant(self, participant_session: ParticipantProtocol) -> str:
+        if compare_versions(self.__server_version, "24.1") < 0:
+            raise RuntimeError(
+                f"System Coupling server version '{self.__server_version}' is too low to"
+                "support this form of 'add_participant'. Minimum version is '24.1'."
+            )
         participant_name = (
             f"{participant_session.participant_type}-{len(self.__participants) + 1}"
         )
@@ -96,14 +103,23 @@ class ParticipantManager:
             )
 
         for region in participant_session.get_regions():
-            part_state.region.create(region.name).set_state(
-                {
-                    "topology": region.topology,
-                    "input_variables": region.input_variables,
-                    "output_variables": region.output_variables,
-                    "display_name": region.display_name,
-                }
-            )
+            region_state = {
+                "topology": region.topology,
+                "input_variables": region.input_variables,
+                "output_variables": region.output_variables,
+                "display_name": region.display_name,
+            }
+            if compare_versions(self.__server_version, "24.2") >= 0:
+                region_state.update(
+                    {
+                        "region_discretization_type": (
+                            region.region_discretization_type
+                            if hasattr(region, "region_discretization_type")
+                            else "Mesh Region"
+                        )
+                    }
+                )
+            part_state.region.create(region.name).set_state(region_state)
 
         self.__participants[participant_name] = participant_session
         return participant_name

ansys/systemcoupling/core/participant/protocol.py

@@ -41,6 +41,7 @@ class Region(Protocol):
     topology: str
     input_variables: List[str]
     output_variables: List[str]
+    region_discretization_type: str = "Mesh Region"
 
 
 class ParticipantProtocol(Protocol):

ansys/systemcoupling/core/session.py

@@ -83,7 +83,7 @@ class Session:
         self.__rpc = rpc
         self.__native_api = None
         self.__syc_version = None
-        self.__part_mgr = ParticipantManager(self)
+        self.__part_mgr = None
 
     def exit(self) -> None:
         """Close the System Coupling server instance.
@@ -138,13 +138,23 @@ class Session:
         self.__rpc.start_output(handle_output)
 
     def end_output(self) -> None:
-        """Cancels output streaming previously started by the ``start_output`` method."""
+        """Cancel output streaming previously started by the ``start_output`` method."""
         self.__rpc.end_output()
 
     def ping(self) -> bool:
         """Simple test that the server is alive and responding."""
         return self.__rpc.ping()
 
+    @property
+    def version(self) -> str:
+        """Return the server version as a string.
+
+        The version string is in the form of dot-separated major and minor
+        version numbers. For example, "24.2".
+        """
+        # Internal version string is in '_'-separated form as that is what is used elsewhere.
+        return self._get_version().replace("_", ".")
+
     @property
     def case(self) -> case_root:
         """Pythonic client-side form of the System Coupling case persistence API."""
@@ -168,18 +178,22 @@ class Session:
             )
         return self.__solution_root
 
+    def _get_version(self):
+        if self.__syc_version is None:
+            proxy = SycProxy(self.__rpc)
+            version = proxy.get_version()
+            self.__syc_version = version.replace(".", "_")
+        return self.__syc_version
+
     def _get_api_root(self, category):
         if isinstance(self.__rpc, _DefunctRpcImpl):
             self.__rpc.trigger_error
         sycproxy = SycProxy(self.__rpc)
-        if self.__syc_version is None:
-            version = sycproxy.get_version()
-            self.__syc_version = version.replace(".", "_")
-        root = get_root(sycproxy, category=category, version=self.__syc_version)
+        root = get_root(sycproxy, category=category, version=self._get_version())
+        if self.__part_mgr is None:
+            self.__part_mgr = ParticipantManager(self, self.__syc_version)
         sycproxy.set_injected_commands(
-            get_injected_cmd_map(
-                self.__syc_version, category, root, self.__part_mgr, self.__rpc
-            )
+            get_injected_cmd_map(category, self, self.__part_mgr, self.__rpc)
         )
         return (root, sycproxy)
 

ansys/systemcoupling/core/syc_version.py

@@ -25,7 +25,7 @@ from typing import Tuple
 # Define constants relating to the default/current version of System Coupling
 
 SYC_MAJOR_VERSION = 24
-SYC_MINOR_VERSION = 1
+SYC_MINOR_VERSION = 2
 
 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

@@ -21,6 +21,7 @@
 # SOFTWARE.
 
 import os
+import shutil
 from typing import Any, Optional, Protocol
 
 
@@ -88,9 +89,22 @@ class PimFileTransferService:  # pragma: no cover
         """
         if os.path.isfile(file_name):
             remote_file_name = remote_file_name or os.path.basename(file_name)
+            delete_copy = False
+            if os.path.dirname(file_name):
+                base_filename = os.path.basename(file_name)
+                dst_file = base_filename
+                dst_file_footer = 0
+                while os.path.exists(dst_file):
+                    dst_file_footer += 1
+                    dst_file = f"{base_filename}_{dst_file_footer}"
+                shutil.copy2(file_name, dst_file)
+                delete_copy = True
+                file_name = dst_file
             if not overwrite and self.file_service.file_exist(remote_file_name):
                 raise FileExistsError(f"{remote_file_name} already exists remotely.")
             self.file_service.upload_file(file_name, remote_file_name)
+            if delete_copy:
+                os.remove(file_name)
         else:
             raise FileNotFoundError(f"Local file {file_name} does not exist.")
 

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

@@ -1,10 +1,10 @@
 Metadata-Version: 2.1
 Name: ansys-systemcoupling-core
-Version: 0.5.0
+Version: 0.7.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.9,<3.13
+Requires-Python: >=3.10,<3.13
 Description-Content-Type: text/x-rst
 Classifier: Development Status :: 4 - Beta
 Classifier: Intended Audience :: Science/Research
@@ -13,41 +13,41 @@ Classifier: License :: OSI Approved :: MIT License
 Classifier: Operating System :: Microsoft :: Windows
 Classifier: Operating System :: POSIX
 Classifier: Operating System :: MacOS
-Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
-Requires-Dist: ansys-api-systemcoupling==0.1.0
+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.62.2
+Requires-Dist: grpcio-status>=1.30.0,<1.66.2
 Requires-Dist: googleapis-common-protos>=1.50.0
-Requires-Dist: protobuf>=3.20.1,<4.0.0
 Requires-Dist: psutil>=5.7.0
 Requires-Dist: pyyaml
 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.4.2 ; extra == "classesgen"
+Requires-Dist: black==24.8.0 ; extra == "classesgen"
 Requires-Dist: isort==5.13.2 ; extra == "classesgen"
-Requires-Dist: ansys-sphinx-theme==0.15.2 ; extra == "doc"
+Requires-Dist: ansys-sphinx-theme==1.0.7 ; extra == "doc"
 Requires-Dist: jupyter_sphinx==0.5.3 ; extra == "doc"
 Requires-Dist: matplotlib ; extra == "doc"
-Requires-Dist: numpydoc==1.7.0 ; extra == "doc"
+Requires-Dist: numpydoc==1.8.0 ; extra == "doc"
 Requires-Dist: pypandoc==1.13 ; extra == "doc"
 Requires-Dist: pytest-sphinx==0.6.3 ; extra == "doc"
-Requires-Dist: Sphinx==7.2.6 ; 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.0.1 ; extra == "doc"
+Requires-Dist: sphinx-autodoc-typehints==2.3.0 ; extra == "doc"
 Requires-Dist: sphinx-copybutton==0.5.2 ; extra == "doc"
-Requires-Dist: sphinx-gallery==0.16.0 ; extra == "doc"
-Requires-Dist: sphinx-notfound-page==1.0.0 ; extra == "doc"
-Requires-Dist: sphinxcontrib-websupport==1.2.7 ; extra == "doc"
+Requires-Dist: sphinx-gallery==0.17.1 ; extra == "doc"
+Requires-Dist: sphinx-notfound-page==1.0.4 ; extra == "doc"
+Requires-Dist: sphinxcontrib-websupport==2.0.0 ; extra == "doc"
 Requires-Dist: sphinxemoji==0.3.1 ; extra == "doc"
-Requires-Dist: ansys-fluent-core ; extra == "doc"
-Requires-Dist: ansys-dpf-core ; extra == "doc"
-Requires-Dist: codespell==2.2.6 ; extra == "style"
-Requires-Dist: flake8==7.0.0 ; extra == "style"
+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: pytest ; extra == "tests"
 Requires-Dist: pytest-cov ; extra == "tests"
 Requires-Dist: psutil>=5.7.0 ; extra == "tests"
@@ -136,12 +136,12 @@ in this order:
 
 * ``SYSC_ROOT``
 * ``AWP_ROOT``
-* ``AWP_ROOT241``
+* ``AWP_ROOT242``
 
 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_ROOT241`` is set.
+In a standard user installation, the expectation is that only ``AWP_ROOT242`` 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.)