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

ansys/systemcoupling/core/adaptor/api_25_1/variable_child.py

@@ -0,0 +1,231 @@
+#
+# This is an auto-generated file.  DO NOT EDIT!
+#
+
+from ansys.systemcoupling.core.adaptor.impl.types import *
+
+from .attribute import attribute
+
+
+class variable_child(Container):
+    """
+    Configure a variable for the coupling participant.
+    """
+
+    syc_name = "child_object_type"
+
+    child_names = ["attribute"]
+
+    attribute: attribute = attribute
+    """
+    attribute child of variable_child.
+    """
+    property_names_types = [
+        ("quantity_type", "QuantityType", "str"),
+        ("location", "Location", "str"),
+        ("participant_display_name", "ParticipantDisplayName", "str"),
+        ("display_name", "DisplayName", "str"),
+        ("data_type", "DataType", "str"),
+        ("real_initial_value", "RealInitialValue", "RealType"),
+        ("integer_initial_value", "IntegerInitialValue", "int"),
+        ("logical_initial_value", "LogicalInitialValue", "bool"),
+        ("string_initial_value", "StringInitialValue", "str"),
+        ("enumeration_initial_value", "EnumerationInitialValue", "int"),
+        ("real_min", "RealMin", "RealType"),
+        ("real_max", "RealMax", "RealType"),
+        ("integer_min", "IntegerMin", "int"),
+        ("integer_max", "IntegerMax", "int"),
+        ("enumeration_min", "EnumerationMin", "int"),
+        ("enumeration_max", "EnumerationMax", "int"),
+        ("tensor_type", "TensorType", "str"),
+        ("is_extensive", "IsExtensive", "bool"),
+    ]
+
+    @property
+    def quantity_type(self) -> str:
+        """Quantity type of the variable.
+
+        Allowed values:
+
+        - \"Unspecified\"
+        - \"Force\"
+        - \"Incremental Displacement\"
+        - \"Temperature\"
+        - \"Heat Rate\"
+        - \"Heat Transfer Coefficient\"
+        - \"Convection Reference Temperature\"
+        - \"Mode Shape\"
+        - \"Electrical Conductivity\" """
+        return self.get_property_state("quantity_type")
+
+    @quantity_type.setter
+    def quantity_type(self, value: str):
+        self.set_property_state("quantity_type", value)
+
+    @property
+    def location(self) -> str:
+        """Data location of the variable (\"Node\" or \"Element\")."""
+        return self.get_property_state("location")
+
+    @location.setter
+    def location(self, value: str):
+        self.set_property_state("location", value)
+
+    @property
+    def participant_display_name(self) -> str:
+        """Variable's display name as defined by the participant solver."""
+        return self.get_property_state("participant_display_name")
+
+    @participant_display_name.setter
+    def participant_display_name(self, value: str):
+        self.set_property_state("participant_display_name", value)
+
+    @property
+    def display_name(self) -> str:
+        """Variable's display name as defined in System Coupling."""
+        return self.get_property_state("display_name")
+
+    @display_name.setter
+    def display_name(self, value: str):
+        self.set_property_state("display_name", value)
+
+    @property
+    def data_type(self) -> str:
+        """Variable's data type as reported by the participant.
+
+        Allowed values (non-FMU case):
+
+        - Real
+        - Complex
+
+        Allowed values (FMU):
+
+        - Real
+        - Integer
+        - Logical
+        - String
+        - Enumeration"""
+        return self.get_property_state("data_type")
+
+    @data_type.setter
+    def data_type(self, value: str):
+        self.set_property_state("data_type", value)
+
+    @property
+    def real_initial_value(self) -> RealType:
+        """Real data start value."""
+        return self.get_property_state("real_initial_value")
+
+    @real_initial_value.setter
+    def real_initial_value(self, value: RealType):
+        self.set_property_state("real_initial_value", value)
+
+    @property
+    def integer_initial_value(self) -> int:
+        """Integer data start value."""
+        return self.get_property_state("integer_initial_value")
+
+    @integer_initial_value.setter
+    def integer_initial_value(self, value: int):
+        self.set_property_state("integer_initial_value", value)
+
+    @property
+    def logical_initial_value(self) -> bool:
+        """Logical data start value."""
+        return self.get_property_state("logical_initial_value")
+
+    @logical_initial_value.setter
+    def logical_initial_value(self, value: bool):
+        self.set_property_state("logical_initial_value", value)
+
+    @property
+    def string_initial_value(self) -> str:
+        """String data start value."""
+        return self.get_property_state("string_initial_value")
+
+    @string_initial_value.setter
+    def string_initial_value(self, value: str):
+        self.set_property_state("string_initial_value", value)
+
+    @property
+    def enumeration_initial_value(self) -> int:
+        """Enumeration data start value."""
+        return self.get_property_state("enumeration_initial_value")
+
+    @enumeration_initial_value.setter
+    def enumeration_initial_value(self, value: int):
+        self.set_property_state("enumeration_initial_value", value)
+
+    @property
+    def real_min(self) -> RealType:
+        """Real data minimum value."""
+        return self.get_property_state("real_min")
+
+    @real_min.setter
+    def real_min(self, value: RealType):
+        self.set_property_state("real_min", value)
+
+    @property
+    def real_max(self) -> RealType:
+        """Real data maximum value."""
+        return self.get_property_state("real_max")
+
+    @real_max.setter
+    def real_max(self, value: RealType):
+        self.set_property_state("real_max", value)
+
+    @property
+    def integer_min(self) -> int:
+        """Integer data minimum value."""
+        return self.get_property_state("integer_min")
+
+    @integer_min.setter
+    def integer_min(self, value: int):
+        self.set_property_state("integer_min", value)
+
+    @property
+    def integer_max(self) -> int:
+        """Integer data maximum value."""
+        return self.get_property_state("integer_max")
+
+    @integer_max.setter
+    def integer_max(self, value: int):
+        self.set_property_state("integer_max", value)
+
+    @property
+    def enumeration_min(self) -> int:
+        """Enumeration data minimum value."""
+        return self.get_property_state("enumeration_min")
+
+    @enumeration_min.setter
+    def enumeration_min(self, value: int):
+        self.set_property_state("enumeration_min", value)
+
+    @property
+    def enumeration_max(self) -> int:
+        """Enumeration data maximum value."""
+        return self.get_property_state("enumeration_max")
+
+    @enumeration_max.setter
+    def enumeration_max(self, value: int):
+        self.set_property_state("enumeration_max", value)
+
+    @property
+    def tensor_type(self) -> str:
+        """Indicates the variable tensor type (\"Scalar\" or \"Vector\").
+
+        \"Vector\" is not supported for the FMU case."""
+        return self.get_property_state("tensor_type")
+
+    @tensor_type.setter
+    def tensor_type(self, value: str):
+        self.set_property_state("tensor_type", value)
+
+    @property
+    def is_extensive(self) -> bool:
+        """Indicates whether this is an extensive property."""
+        return self.get_property_state("is_extensive")
+
+    @is_extensive.setter
+    def is_extensive(self, value: bool):
+        self.set_property_state("is_extensive", value)

ansys/systemcoupling/core/adaptor/api_25_1/write_csv_chart_files.py

@@ -0,0 +1,21 @@
+#
+# This is an auto-generated file.  DO NOT EDIT!
+#
+
+from ansys.systemcoupling.core.adaptor.impl.types import *
+
+
+class write_csv_chart_files(Command):
+    """
+    For each coupling interface, exports a CSV file containing chart data
+    (convergence and source/target quantity transfer values) for
+    that interface.
+
+    Each file is named according to the convention ``<interface>.csv``, where
+    ``<interface>`` is the object name of the corresponding coupling interface.
+
+    This command will overwrite any CSV charting files that already exist,
+    including any that were written during the solution.
+    """
+
+    syc_name = "WriteCsvChartFiles"

ansys/systemcoupling/core/adaptor/api_25_1/write_ensight.py

@@ -0,0 +1,46 @@
+#
+# This is an auto-generated file.  DO NOT EDIT!
+#
+
+from ansys.systemcoupling.core.adaptor.impl.types import *
+
+
+class write_ensight(Command):
+    """
+    Write a file with mesh and results which can be loaded into Ensight for
+    post processing.
+
+    Parameters
+    ----------
+    file_name : str
+        Base name for Ensight files. It will generate <base>.encas file which
+        should be loaded into Ensight. Other files are generated for geometry
+        and variables.
+    binary : bool, optional
+        To control if file is to be written in binary format or ASCII. ASCII
+        slows down performance, but may be useful for debugging and seeing
+        raw data.
+
+    """
+
+    syc_name = "WriteEnSight"
+
+    argument_names = ["file_name", "binary"]
+
+    class file_name(String):
+        """
+        Base name for Ensight files. It will generate <base>.encas file which
+        should be loaded into Ensight. Other files are generated for geometry
+        and variables.
+        """
+
+        syc_name = "FileName"
+
+    class binary(Boolean):
+        """
+        To control if file is to be written in binary format or ASCII. ASCII
+        slows down performance, but may be useful for debugging and seeing
+        raw data.
+        """
+
+        syc_name = "Binary"

ansys/systemcoupling/core/adaptor/impl/injected_commands.py

@@ -149,6 +149,8 @@ def _wrap_add_participant(
 
     if input_file := kwargs.get("input_file", None):
         session.upload_file(input_file)
+        if os.path.dirname(input_file):
+            kwargs["input_file"] = os.path.basename(input_file)
 
     return setup._add_participant(**kwargs)
 

ansys/systemcoupling/core/client/syc_container.py

@@ -76,6 +76,18 @@ def start_container(
         f"ghcr.io/ansys/pysystem-coupling:{image_tag}",
     ] + args
 
+    container_user = os.getenv("SYC_CONTAINER_USER")
+    if container_user:
+        idx = run_args.index("-p")
+        run_args.insert(idx, container_user)
+        run_args.insert(idx, "--user")
+
+    license_server = os.getenv("ANSYSLMD_LICENSE_FILE")
+    if license_server:
+        idx = run_args.index("-e")
+        run_args.insert(idx, f"ANSYSLMD_LICENSE_FILE={license_server}")
+        run_args.insert(idx, "-e")
+
     if network:
         idx = run_args.index("-p")
         run_args.insert(idx, network)

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/session.py

@@ -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,14 +178,18 @@ 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(

ansys/systemcoupling/core/util/file_transfer.py

@@ -21,6 +21,7 @@
 # SOFTWARE.
 
 import os
+import shutil
 from typing import Any, Optional, Protocol
 
 
@@ -88,13 +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):
-                raise IsADirectoryError(
-                    f"{remote_file_name} is not in the current working directory"
-                )
+                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.6.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.6
+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,42 +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.64.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.16.6 ; 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.3.7 ; 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.2.2 ; 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.2 ; 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: 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.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"