ansys-systemcoupling-core 0.3.0__tar.gz → 0.4.dev0__tar.gz

{ansys_systemcoupling_core-0.3.0 → ansys_systemcoupling_core-0.4.dev0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: ansys-systemcoupling-core
-Version: 0.3.0
+Version: 0.4.dev0
 Summary: A Python wrapper for Ansys System Coupling.
 Author-email: "ANSYS, Inc." <pyansys.support@ansys.com>
 Maintainer-email: PyAnsys developers <pyansys.maintainers@ansys.com>
@@ -19,7 +19,7 @@ Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Requires-Dist: ansys-api-systemcoupling==0.1.0
 Requires-Dist: grpcio>=1.30.0
-Requires-Dist: grpcio-status>=1.30.0,<1.58.1
+Requires-Dist: grpcio-status>=1.30.0,<1.60.2
 Requires-Dist: googleapis-common-protos>=1.50.0
 Requires-Dist: protobuf>=3.20.1,<4.0.0
 Requires-Dist: psutil>=5.7.0
@@ -27,26 +27,26 @@ Requires-Dist: pyyaml
 Requires-Dist: appdirs>=1.4.0
 Requires-Dist: importlib-metadata>=4.0
 Requires-Dist: build ; extra == "build"
-Requires-Dist: black==23.7.0 ; extra == "classesgen"
-Requires-Dist: isort==5.12.0 ; extra == "classesgen"
-Requires-Dist: ansys-sphinx-theme==0.11.2 ; extra == "doc"
-Requires-Dist: jupyter_sphinx==0.4.0 ; extra == "doc"
+Requires-Dist: black==24.1.1 ; extra == "classesgen"
+Requires-Dist: isort==5.13.2 ; extra == "classesgen"
+Requires-Dist: ansys-sphinx-theme==0.13.3 ; extra == "doc"
+Requires-Dist: jupyter_sphinx==0.5.3 ; extra == "doc"
 Requires-Dist: matplotlib ; extra == "doc"
-Requires-Dist: numpydoc==1.5.0 ; extra == "doc"
-Requires-Dist: pypandoc==1.11 ; extra == "doc"
-Requires-Dist: pytest-sphinx==0.5.0 ; extra == "doc"
+Requires-Dist: numpydoc==1.6.0 ; extra == "doc"
+Requires-Dist: pypandoc==1.12 ; extra == "doc"
+Requires-Dist: pytest-sphinx==0.6.0 ; extra == "doc"
 Requires-Dist: Sphinx==7.2.6 ; extra == "doc"
-Requires-Dist: sphinx-autobuild==2021.3.14 ; extra == "doc"
-Requires-Dist: sphinx-autodoc-typehints==1.24.0 ; extra == "doc"
+Requires-Dist: sphinx-autobuild==2024.2.4 ; extra == "doc"
+Requires-Dist: sphinx-autodoc-typehints==1.25.2 ; extra == "doc"
 Requires-Dist: sphinx-copybutton==0.5.2 ; extra == "doc"
-Requires-Dist: sphinx-gallery==0.14.0 ; extra == "doc"
+Requires-Dist: sphinx-gallery==0.15.0 ; extra == "doc"
 Requires-Dist: sphinx-notfound-page==1.0.0 ; extra == "doc"
-Requires-Dist: sphinxcontrib-websupport==1.2.6 ; extra == "doc"
-Requires-Dist: sphinxemoji==0.2.0 ; extra == "doc"
+Requires-Dist: sphinxcontrib-websupport==1.2.7 ; 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.5 ; extra == "style"
-Requires-Dist: flake8==6.1.0 ; extra == "style"
+Requires-Dist: codespell==2.2.6 ; extra == "style"
+Requires-Dist: flake8==7.0.0 ; extra == "style"
 Requires-Dist: pytest ; extra == "tests"
 Requires-Dist: pytest-cov ; extra == "tests"
 Requires-Dist: psutil>=5.7.0 ; extra == "tests"
@@ -135,12 +135,12 @@ in this order:
 
 * ``SYSC_ROOT``
 * ``AWP_ROOT``
-* ``AWP_ROOT232``
+* ``AWP_ROOT241``
 
 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_ROOT232`` is set.
+In a standard user installation, the expectation is that only ``AWP_ROOT241`` 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.)
@@ -157,6 +157,7 @@ However, if you are transitioning existing scripts, the native System Coupling A
 as a convenience.
 
 .. 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.
 

{ansys_systemcoupling_core-0.3.0 → ansys_systemcoupling_core-0.4.dev0}/README.rst

@@ -73,12 +73,12 @@ in this order:
 
 * ``SYSC_ROOT``
 * ``AWP_ROOT``
-* ``AWP_ROOT232``
+* ``AWP_ROOT241``
 
 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_ROOT232`` is set.
+In a standard user installation, the expectation is that only ``AWP_ROOT241`` 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.)
@@ -95,6 +95,7 @@ However, if you are transitioning existing scripts, the native System Coupling A
 as a convenience.
 
 .. 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.
 

{ansys_systemcoupling_core-0.3.0 → ansys_systemcoupling_core-0.4.dev0}/pyproject.toml

@@ -5,7 +5,7 @@ build-backend = "flit_core.buildapi"
 [project]
 # Check https://flit.readthedocs.io/en/latest/pyproject_toml.html for all available sections
 name = "ansys-systemcoupling-core"
-version = "0.3.0"
+version = "0.4.dev0"
 description = "A Python wrapper for Ansys System Coupling."
 readme = "README.rst"
 requires-python = ">=3.7"
@@ -19,7 +19,7 @@ maintainers = [
 dependencies = [
 	"ansys-api-systemcoupling==0.1.0",
 	"grpcio>=1.30.0",
-	"grpcio-status>=1.30.0,<1.58.1",
+	"grpcio-status>=1.30.0,<1.60.2",
 	"googleapis-common-protos>=1.50.0",
 	"protobuf>=3.20.1,<4.0.0",
 	"psutil>=5.7.0",
@@ -52,32 +52,32 @@ classesgen = [
 	# black and isort are called programmatically to keep generated code
 	# consistent with style elsewhere. We need to keep the versions in
 	# sync with the precommit dependencies.
-	"black==23.7.0",
-	"isort==5.12.0",
+	"black==24.1.1",
+	"isort==5.13.2",
 ]
 doc = [
-	"ansys-sphinx-theme==0.11.2",
-	"jupyter_sphinx==0.4.0",
+	"ansys-sphinx-theme==0.13.3",
+	"jupyter_sphinx==0.5.3",
 	"matplotlib",
-	"numpydoc==1.5.0",
-	"pypandoc==1.11",
-	"pytest-sphinx==0.5.0",
+	"numpydoc==1.6.0",
+	"pypandoc==1.12",
+	"pytest-sphinx==0.6.0",
 	"Sphinx==7.2.6",
-	"sphinx-autobuild==2021.3.14",
-	"sphinx-autodoc-typehints==1.24.0",
+	"sphinx-autobuild==2024.2.4",
+	"sphinx-autodoc-typehints==1.25.2",
 	"sphinx-copybutton==0.5.2",
-	"sphinx-gallery==0.14.0",
+	"sphinx-gallery==0.15.0",
 	"sphinx-notfound-page==1.0.0",
-	"sphinxcontrib-websupport==1.2.6",
-	"sphinxemoji==0.2.0",
+	"sphinxcontrib-websupport==1.2.7",
+	"sphinxemoji==0.3.1",
 
 	# pyansys dependencies for sphinx gallery examples
 	"ansys-fluent-core",
 	"ansys-dpf-core",
 ]
 style = [
-	"codespell==2.2.5",
-	"flake8==6.1.0",
+	"codespell==2.2.6",
+	"flake8==7.0.0",
 ]
 tests = [
 	"pytest",

{ansys_systemcoupling_core-0.3.0 → ansys_systemcoupling_core-0.4.dev0}/src/ansys/systemcoupling/core/__init__.py

@@ -1,3 +1,25 @@
+# Copyright (C) 2023 - 2024 ANSYS, Inc. and/or its affiliates.
+# SPDX-License-Identifier: MIT
+#
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
 import os
 from typing import List
 
@@ -47,7 +69,7 @@ def launch(
         (The forms ``"23.1"`` and ``"23_1"`` are also acceptable.)
         The version will be sought in the standard installation location. The
         default is ``None``, which is equivalent to specifying
-        ``"232"`` ("2023 R2" release), unless either of the environment
+        ``"241"`` ("2024 R1" release), unless either of the environment
         variables ``SYSC_ROOT`` or ``AWP_ROOT`` has been set. It is considered
         to be an error if either these is set *and* ``version`` is provided.
     extra_args : List[str]

ansys_systemcoupling_core-0.4.dev0/src/ansys/systemcoupling/core/_version.py

@@ -0,0 +1,39 @@
+# Copyright (C) 2023 - 2024 ANSYS, Inc. and/or its affiliates.
+# SPDX-License-Identifier: MIT
+#
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
+"""Version of ansys-systemcoupling-core library.
+
+On the ``main`` branch, use 'dev0' to denote a development version.
+For example:
+
+version_info = 0, 1, 'dev0'
+
+"""
+
+try:
+    import importlib.metadata as importlib_metadata
+except ModuleNotFoundError:  # pragma: no cover
+    import importlib_metadata
+
+# Read from the pyproject.toml
+# major, minor, patch
+__version__ = importlib_metadata.version("ansys.systemcoupling.core")

{ansys_systemcoupling_core-0.3.0/src/ansys/systemcoupling/core/adaptor/api_24_1 → ansys_systemcoupling_core-0.4.dev0/src/ansys/systemcoupling/core/adaptor/api_23_1}/analysis_control.py

@@ -5,7 +5,6 @@
 from ansys.systemcoupling.core.adaptor.impl.types import *
 
 from .apip import apip
-from .automatic_alignment_options import automatic_alignment_options
 from .avoid_data_reconstruction import avoid_data_reconstruction
 from .global_stabilization import global_stabilization
 from .unmapped_value_options import unmapped_value_options
@@ -23,7 +22,6 @@ class analysis_control(Container):
         "apip",
         "avoid_data_reconstruction",
         "unmapped_value_options",
-        "automatic_alignment_options",
     ]
 
     global_stabilization: global_stabilization = global_stabilization
@@ -42,12 +40,6 @@ class analysis_control(Container):
     """
     unmapped_value_options child of analysis_control.
     """
-    automatic_alignment_options: automatic_alignment_options = (
-        automatic_alignment_options
-    )
-    """
-    automatic_alignment_options child of analysis_control.
-    """
     property_names_types = [
         ("analysis_type", "AnalysisType", "str"),
         ("optimize_if_one_way", "OptimizeIfOneWay", "bool"),

ansys_systemcoupling_core-0.4.dev0/src/ansys/systemcoupling/core/adaptor/api_23_1/avoid_data_reconstruction.py

@@ -0,0 +1,36 @@
+#
+# This is an auto-generated file.  DO NOT EDIT!
+#
+
+from ansys.systemcoupling.core.adaptor.impl.types import *
+
+
+class avoid_data_reconstruction(Container):
+    """
+    Control whether data reconstruction should be done for elemental intensive data.
+    """
+
+    syc_name = "AvoidDataReconstruction"
+
+    property_names_types = [
+        ("volume_mapping", "VolumeMapping", "bool"),
+        ("surface_mapping", "SurfaceMapping", "bool"),
+    ]
+
+    @property
+    def volume_mapping(self) -> bool:
+        """UNDOCUMENTED"""
+        return self.get_property_state("volume_mapping")
+
+    @volume_mapping.setter
+    def volume_mapping(self, value: bool):
+        self.set_property_state("volume_mapping", value)
+
+    @property
+    def surface_mapping(self) -> bool:
+        """UNDOCUMENTED"""
+        return self.get_property_state("surface_mapping")
+
+    @surface_mapping.setter
+    def surface_mapping(self, value: bool):
+        self.set_property_state("surface_mapping", value)

ansys_systemcoupling_core-0.4.dev0/src/ansys/systemcoupling/core/adaptor/api_23_1/coupling_participant_child.py

@@ -0,0 +1,173 @@
+#
+# This is an auto-generated file.  DO NOT EDIT!
+#
+
+from ansys.systemcoupling.core.adaptor.impl.types import *
+
+from .execution_control import execution_control
+from .external_data_file import external_data_file
+from .fmu_parameter import fmu_parameter
+from .region import region
+from .update_control import update_control
+from .variable import variable
+
+
+class coupling_participant_child(Container):
+    """
+    Configure a coupling participant.
+
+    These settings are typically populated by using the ``add_participant``
+    command.
+    """
+
+    syc_name = "child_object_type"
+
+    child_names = [
+        "variable",
+        "region",
+        "update_control",
+        "fmu_parameter",
+        "execution_control",
+        "external_data_file",
+    ]
+
+    variable: variable = variable
+    """
+    variable child of coupling_participant_child.
+    """
+    region: region = region
+    """
+    region child of coupling_participant_child.
+    """
+    update_control: update_control = update_control
+    """
+    update_control child of coupling_participant_child.
+    """
+    fmu_parameter: fmu_parameter = fmu_parameter
+    """
+    fmu_parameter child of coupling_participant_child.
+    """
+    execution_control: execution_control = execution_control
+    """
+    execution_control child of coupling_participant_child.
+    """
+    external_data_file: external_data_file = external_data_file
+    """
+    external_data_file child of coupling_participant_child.
+    """
+    property_names_types = [
+        ("participant_type", "ParticipantType", "str"),
+        ("participant_display_name", "ParticipantDisplayName", "str"),
+        ("display_name", "DisplayName", "str"),
+        ("dimension", "Dimension", "str"),
+        ("participant_file_loaded", "ParticipantFileLoaded", "str"),
+        ("logging_on", "LoggingOn", "bool"),
+        ("participant_analysis_type", "ParticipantAnalysisType", "str"),
+        ("use_new_apis", "UseNewAPIs", "bool"),
+        ("restarts_supported", "RestartsSupported", "bool"),
+        ("instancing", "Instancing", "str"),
+    ]
+
+    @property
+    def participant_type(self) -> str:
+        """Coupling participant type.
+
+        Allowed values:
+        - \"DEFAULT\"
+        - \"CFX\"
+        - \"FLUENT\"
+        - \"MAPDL\"
+        - \"AEDT\"
+        - \"FMU\"
+        - \"EXTERNALDATA\"
+        - \"FORTE\"
+        - \"DEFAULT-SRV\"
+        - \"MECH-SRV\"
+        - \"CFD-SRV\" """
+        return self.get_property_state("participant_type")
+
+    @participant_type.setter
+    def participant_type(self, value: str):
+        self.set_property_state("participant_type", value)
+
+    @property
+    def participant_display_name(self) -> str:
+        """Participant's display name as defined by the participant solver (as
+        opposed to System Coupling's ``display_name`` for the participant)."""
+        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:
+        """Participant'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 dimension(self) -> str:
+        """Dimension of the participant (\"2D\" or \"3D\")."""
+        return self.get_property_state("dimension")
+
+    @dimension.setter
+    def dimension(self, value: str):
+        self.set_property_state("dimension", value)
+
+    @property
+    def participant_file_loaded(self) -> str:
+        """File used to generate the participant."""
+        return self.get_property_state("participant_file_loaded")
+
+    @participant_file_loaded.setter
+    def participant_file_loaded(self, value: str):
+        self.set_property_state("participant_file_loaded", value)
+
+    @property
+    def logging_on(self) -> bool:
+        """Specifies whether logging is activated for the participant."""
+        return self.get_property_state("logging_on")
+
+    @logging_on.setter
+    def logging_on(self, value: bool):
+        self.set_property_state("logging_on", value)
+
+    @property
+    def participant_analysis_type(self) -> str:
+        """Coupling participant analysis type (\"Steady\" or \"Transient\")."""
+        return self.get_property_state("participant_analysis_type")
+
+    @participant_analysis_type.setter
+    def participant_analysis_type(self, value: str):
+        self.set_property_state("participant_analysis_type", value)
+
+    @property
+    def use_new_apis(self) -> bool:
+        """Controls whether a Fluent or MAPDL participant should communicate using new APIs."""
+        return self.get_property_state("use_new_apis")
+
+    @use_new_apis.setter
+    def use_new_apis(self, value: bool):
+        self.set_property_state("use_new_apis", value)
+
+    @property
+    def restarts_supported(self) -> bool:
+        """Indicates whether the participant supports restarts."""
+        return self.get_property_state("restarts_supported")
+
+    @restarts_supported.setter
+    def restarts_supported(self, value: bool):
+        self.set_property_state("restarts_supported", value)
+
+    @property
+    def instancing(self) -> str:
+        """Set instancing on the participant."""
+        return self.get_property_state("instancing")
+
+    @instancing.setter
+    def instancing(self, value: str):
+        self.set_property_state("instancing", value)

ansys_systemcoupling_core-0.4.dev0/src/ansys/systemcoupling/core/adaptor/api_23_1/fmu_parameter_child.py

@@ -0,0 +1,126 @@
+#
+# This is an auto-generated file.  DO NOT EDIT!
+#
+
+from ansys.systemcoupling.core.adaptor.impl.types import *
+
+
+class fmu_parameter_child(Container):
+    """
+    Configure a parameter for an FMU coupling participant.
+    """
+
+    syc_name = "child_object_type"
+
+    property_names_types = [
+        ("data_type", "DataType", "str"),
+        ("participant_display_name", "ParticipantDisplayName", "str"),
+        ("display_name", "DisplayName", "str"),
+        ("real_value", "RealValue", "RealType"),
+        ("real_min", "RealMin", "RealType"),
+        ("real_max", "RealMax", "RealType"),
+        ("integer_value", "IntegerValue", "int"),
+        ("integer_min", "IntegerMin", "int"),
+        ("integer_max", "IntegerMax", "int"),
+        ("logical_value", "LogicalValue", "bool"),
+        ("string_value", "StringValue", "str"),
+    ]
+
+    @property
+    def data_type(self) -> str:
+        """UNDOCUMENTED"""
+        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 participant_display_name(self) -> str:
+        """Parameter'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:
+        """Parameter'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 real_value(self) -> RealType:
+        """Real data start value."""
+        return self.get_property_state("real_value")
+
+    @real_value.setter
+    def real_value(self, value: RealType):
+        self.set_property_state("real_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_value(self) -> int:
+        """Integer data start value."""
+        return self.get_property_state("integer_value")
+
+    @integer_value.setter
+    def integer_value(self, value: int):
+        self.set_property_state("integer_value", 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 logical_value(self) -> bool:
+        """Logical data start value."""
+        return self.get_property_state("logical_value")
+
+    @logical_value.setter
+    def logical_value(self, value: bool):
+        self.set_property_state("logical_value", value)
+
+    @property
+    def string_value(self) -> str:
+        """String data start value."""
+        return self.get_property_state("string_value")
+
+    @string_value.setter
+    def string_value(self, value: str):
+        self.set_property_state("string_value", value)