ansys-systemcoupling-core 0.9.0__tar.gz → 0.10.0__tar.gz

{ansys_systemcoupling_core-0.9.0 → ansys_systemcoupling_core-0.10.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ansys-systemcoupling-core
-Version: 0.9.0
+Version: 0.10.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>
@@ -20,6 +20,7 @@ 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: docker>=7.1.0
 Requires-Dist: grpcio>=1.30.0
 Requires-Dist: grpcio-status>=1.30.0
 Requires-Dist: googleapis-common-protos>=1.50.0
@@ -31,10 +32,10 @@ Requires-Dist: matplotlib>=3.8.2
 Requires-Dist: build ; extra == "build"
 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: ansys-sphinx-theme==1.5.3 ; 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: numpydoc==1.9.0 ; extra == "doc"
 Requires-Dist: pypandoc==1.15 ; extra == "doc"
 Requires-Dist: pytest-sphinx==0.6.3 ; extra == "doc"
 Requires-Dist: sphinx>=8.1.3 ; extra == "doc"
@@ -45,10 +46,10 @@ 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.29.0 ; extra == "doc"
-Requires-Dist: ansys-mapdl-core==0.69.3 ; extra == "doc"
+Requires-Dist: ansys-fluent-core==0.33.0 ; extra == "doc"
+Requires-Dist: ansys-mapdl-core==0.70.2 ; extra == "doc"
 Requires-Dist: codespell==2.4.1 ; extra == "style"
-Requires-Dist: flake8==7.1.2 ; extra == "style"
+Requires-Dist: flake8==7.3.0 ; extra == "style"
 Requires-Dist: pytest ; extra == "tests"
 Requires-Dist: pytest-cov ; extra == "tests"
 Requires-Dist: psutil>=5.7.0 ; extra == "tests"
@@ -149,13 +150,18 @@ function. This will affect which ``AWP_ROOT<version>`` environment variable is e
 
    **WARNING**
 
+   Note that the following applies only to the 25 R1 release of Ansys System Coupling.
+
    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.
+   allow System Coupling 25 R1 to work with PySystemCoupling releases 0.9 and later.
+
+   This issue is not present in later releases of System Coupling. If a later release
+   is available, you are recommended to use that.
 
-   Otherwise, PySystemCoupling should be used with an earlier release of System Coupling by
+   Alternatively, PySystemCoupling can 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.
 

{ansys_systemcoupling_core-0.9.0 → ansys_systemcoupling_core-0.10.0}/README.rst

@@ -85,13 +85,18 @@ function. This will affect which ``AWP_ROOT<version>`` environment variable is e
 
    **WARNING**
 
+   Note that the following applies only to the 25 R1 release of Ansys System Coupling.
+
    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.
+   allow System Coupling 25 R1 to work with PySystemCoupling releases 0.9 and later.
+
+   This issue is not present in later releases of System Coupling. If a later release
+   is available, you are recommended to use that.
 
-   Otherwise, PySystemCoupling should be used with an earlier release of System Coupling by
+   Alternatively, PySystemCoupling can 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.
 

{ansys_systemcoupling_core-0.9.0 → ansys_systemcoupling_core-0.10.0}/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.9.0"
+version = "0.10.0"
 description = "A Python wrapper for Ansys System Coupling."
 readme = "README.rst"
 requires-python = ">=3.10,<3.14"
@@ -19,6 +19,7 @@ maintainers = [
 dependencies = [
     "ansys-api-systemcoupling==0.2.0",
     "ansys-platform-instancemanagement~=1.0",
+    "docker>=7.1.0",
     "grpcio>=1.30.0",
     "grpcio-status>=1.30.0",
     "googleapis-common-protos>=1.50.0",
@@ -57,10 +58,10 @@ classesgen = [
 	"isort==6.0.1",
 ]
 doc = [
-	"ansys-sphinx-theme==1.3.2",
+	"ansys-sphinx-theme==1.5.3",
 	"jupyter_sphinx==0.5.3",
 	"matplotlib",
-	"numpydoc==1.8.0",
+	"numpydoc==1.9.0",
 	"pypandoc==1.15",
 	"pytest-sphinx==0.6.3",
 	"sphinx>=8.1.3",
@@ -73,13 +74,13 @@ doc = [
 	"sphinxemoji==0.3.1",
 
 	# pyansys dependencies for sphinx gallery examples
-	"ansys-fluent-core==0.29.0",
-	"ansys-mapdl-core==0.69.3",
+	"ansys-fluent-core==0.33.0",
+	"ansys-mapdl-core==0.70.2",
 ]
 style = [
 	# NB: ensure these remain synced with .pre-commit-config.yaml
 	"codespell==2.4.1",
-	"flake8==7.1.2",
+	"flake8==7.3.0",
 ]
 tests = [
 	"pytest",

{ansys_systemcoupling_core-0.9.0 → ansys_systemcoupling_core-0.10.0}/src/ansys/systemcoupling/core/__init__.py

@@ -72,7 +72,7 @@ def launch(
         (The forms ``"24.1"`` and ``"24_1"`` are also acceptable.)
         The version will be sought in the standard installation location. The
         default is ``None``, which is equivalent to specifying
-        ``"251"`` ("2025 R1" release), unless either of the environment
+        ``"252"`` ("2025 R2" 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.
     start_output: bool, optional

{ansys_systemcoupling_core-0.9.0 → ansys_systemcoupling_core-0.10.0}/src/ansys/systemcoupling/core/adaptor/api_25_2/add_data_transfer.py

@@ -9,10 +9,10 @@ class add_data_transfer(Command):
     """
     Adds data transfer based on arguments that specify the interface, target
     side, and variables to be associated with each side of the interface.
-    The command requires that you specify variables using their names (see
-    parameter descriptions for details). Either a variable-based or
+    The command requires that you specify variables using their names, as
+    described below in Essential Keyword Arguments. Either a variable-based or
     expression-based data transfer may be created with this command based on
-    the arguments provided. If a variable-based data transfer argument
+    the Optional Keyword Arguments. If a variable-based data transfer argument
     is given, then no expression-based data transfer arguments can be used. If
     an expression-based data transfer argument is given, then no variable-based
     data transfer arguments can be used.
@@ -36,8 +36,8 @@ class add_data_transfer(Command):
     target_variable : str, optional
         String specifying the name of the variable on the target side of
         the data transfer. Must be combined with either ``source_variable`` (when
-        creating a variable-based data transfer) or with ``value`` (or
-        ``value_{x|y|z}`` (when creating an expression-based data transfer).
+        creating a variable-based data transfer) or with ``value_{x|y|z}``
+        (when creating an expression-based data transfer).
     value : str, optional
         String specifying the expression to use on the source side of the data
         transfer. Used when creating an expression-based data transfer. If the
@@ -48,7 +48,7 @@ class add_data_transfer(Command):
         String specifying the X component of the expression to use on the
         source side of the data transfer. This may optionally be used when creating
         an expression-based data transfer if the ``target_variable`` is a vector as an
-        alternative to specifying a vector-valued expression in ``value`. ``value_y`` and
+        alternative to specifying a vector-valued expression in ``value``. ``value_y`` and
         ``value_z`` are also required if ``value_x`` is used.
     value_y : str, optional
         String specifying the Y component of the expression to use on the
@@ -119,8 +119,8 @@ class add_data_transfer(Command):
         """
         String specifying the name of the variable on the target side of
         the data transfer. Must be combined with either ``source_variable`` (when
-        creating a variable-based data transfer) or with ``value`` (or
-        ``value_{x|y|z}`` (when creating an expression-based data transfer).
+        creating a variable-based data transfer) or with ``value_{x|y|z}``
+        (when creating an expression-based data transfer).
         """
 
         syc_name = "TargetVariable"
@@ -141,7 +141,7 @@ class add_data_transfer(Command):
         String specifying the X component of the expression to use on the
         source side of the data transfer. This may optionally be used when creating
         an expression-based data transfer if the ``target_variable`` is a vector as an
-        alternative to specifying a vector-valued expression in ``value`. ``value_y`` and
+        alternative to specifying a vector-valued expression in ``value``. ``value_y`` and
         ``value_z`` are also required if ``value_x`` is used.
         """
 

{ansys_systemcoupling_core-0.9.0 → ansys_systemcoupling_core-0.10.0}/src/ansys/systemcoupling/core/adaptor/api_25_2/add_interface.py

@@ -10,7 +10,7 @@ class add_interface(Command):
     Adds an interface based on the participant and region names specified
     as arguments for each side of the interface. This command requires that
     you specify participants using their names as described below in
-    Essential Keyword Arguments. Non-FMU participants must provide a list
+    Essential Keyword Arguments. Non-FMU participants can provide a list
     of regions as described below in Optional Keyword Arguments. For FMU
     interfaces, specifying the regions are not allowed.
 

{ansys_systemcoupling_core-0.9.0 → ansys_systemcoupling_core-0.10.0}/src/ansys/systemcoupling/core/adaptor/api_25_2/add_ordered_data_transfers.py

@@ -7,9 +7,18 @@ from ansys.systemcoupling.core.adaptor.impl.types import *
 
 class add_ordered_data_transfers(Command):
     """
-    Adds data transfer for each ordered pair of variables in an FMU-FMU interface.
-
-    Returns the name of the Data Transfers created.
+    Adds data transfer for each ordered pair of variables in an
+    FMU-FMU interface. Requires the FMU-FMU interface. Requires
+    that the target FMU has the same number of input variables
+    as the source FMU has output variables.
+    The transfers are added in order. That is, the n-th output
+    variable for side one will be connected to the n-th input
+    variable for side two. This is only available for interfaces
+    with FMUs on both side one and side two.
+
+    Data transfers will be created in both directions, if possible.
+
+    Returns the name of the data transfers created.
 
     Parameters
     ----------

{ansys_systemcoupling_core-0.9.0 → ansys_systemcoupling_core-0.10.0}/src/ansys/systemcoupling/core/adaptor/api_25_2/add_participant.py

@@ -31,13 +31,8 @@ class add_participant(InjectedCommand):
 
     The remainder of the documentation describes the more usual non-session mode.
 
-    Adds a coupling participant to the data model.
-
-    When executed, this command adds the new participant to the analysis
-    without removing any interfaces or data transfers created previously.
-
+    Adds a coupling participant to the setup.
     Cannot be called after participants have been started.
-
     Returns the name of the participant.
 
     There are several options that can be selected to add the
@@ -76,8 +71,8 @@ class add_participant(InjectedCommand):
     input_file : str, optional
         Name of the input file for the participant to be added.
         Currently supported formats are SCP files, Forte input (FTSIM)
-        files, mechanical server (\*.rst) files, cfd server (\*.csv) files,
-        FMU (\*.fmu) files, and System Coupling data server (\*.scdt/axdt/csv) files.
+        files, Mechanical Server (\*.rst) files, CFD Server (\*.csv) files,
+        FMU (\*.fmu) files, and System Coupling Data Server (\*.scdt/axdt/csv) files.
     executable : str, optional
         Path to the executable file for the participant to be added.
     additional_arguments : str, optional
@@ -87,7 +82,17 @@ class add_participant(InjectedCommand):
     python_script : str, optional
         Instead of the executable, use a Python script and wrap it with
         System Coupling-provided .bat/.sh scripts to set up the environment
-        correctly before calling this Python script.
+        correctly before calling this Python script. On Windows, a few
+        lines will need to be included near the top of the Python script to
+        add the required dll directories as follows:
+
+        .. code-block:: python
+
+            import os
+            import sys
+            if sys.platform.startswith("win"):
+                for p in os.environ["PYTHON_DLL_PATH"].split(os.pathsep):
+                    os.add_dll_directory(p)
 
     """
 
@@ -125,8 +130,8 @@ class add_participant(InjectedCommand):
         """
         Name of the input file for the participant to be added.
         Currently supported formats are SCP files, Forte input (FTSIM)
-        files, mechanical server (\*.rst) files, cfd server (\*.csv) files,
-        FMU (\*.fmu) files, and System Coupling data server (\*.scdt/axdt/csv) files.
+        files, Mechanical Server (\*.rst) files, CFD Server (\*.csv) files,
+        FMU (\*.fmu) files, and System Coupling Data Server (\*.scdt/axdt/csv) files.
         """
 
         syc_name = "InputFile"
@@ -156,7 +161,17 @@ class add_participant(InjectedCommand):
         """
         Instead of the executable, use a Python script and wrap it with
         System Coupling-provided .bat/.sh scripts to set up the environment
-        correctly before calling this Python script.
+        correctly before calling this Python script. On Windows, a few
+        lines will need to be included near the top of the Python script to
+        add the required dll directories as follows:
+
+        .. code-block:: python
+
+            import os
+            import sys
+            if sys.platform.startswith("win"):
+                for p in os.environ["PYTHON_DLL_PATH"].split(os.pathsep):
+                    os.add_dll_directory(p)
         """
 
         syc_name = "PythonScript"

ansys_systemcoupling_core-0.10.0/src/ansys/systemcoupling/core/adaptor/api_25_2/add_transformation.py

@@ -0,0 +1,102 @@
+#
+# This is an auto-generated file.  DO NOT EDIT!
+#
+
+from ansys.systemcoupling.core.adaptor.impl.types import *
+
+
+class add_transformation(Command):
+    """
+    Add a transformation to a reference frame defined in the datamodel
+
+    Given the reference frame to add to the transform to, the type of transform
+    to be added, and any required information for the transformation, add the
+    transformation to the referenceFrame. Not all parameters are required for
+    every transformation.
+
+    The name of the transformation will be based on the type of transformation.
+    The name will be of the form ``<transformation_type>-#`` where ``#`` is the first
+    positive integer which yields a unique frame name.
+
+    The transformation will also be added to the end of the ``transformation_order``
+    list for the reference frame.
+
+    Returns the name of the transformation.
+
+    Parameters
+    ----------
+    reference_frame : str
+        Name of the reference frame to which the transformation will be added.
+    transformation_type : str
+        Type of transformation to be added. Available options are Rotation or
+        Translation
+
+        Required Parameters for Transformation Types:
+            Rotation: ``angle``, ``axis``, ``vector`` (if ``axis`` is \"UserDefined\")
+            Translation: ``vector``
+    angle : real, optional
+        Angle to rotate a reference frame. Used with Rotation
+        ``transformation_type``. Default unit is Radians.
+    axis : str, optional
+        Axis about which a rotation is applied. Used with
+        Rotation ``transformation_type``. Available options are: "XAxis", "YAxis",
+        "ZAxis", and "UserDefined".
+    vector : Tuple, optional
+        A vector for use with Translation ``transformation_type`` or Rotation
+        ``transformation_type`` if the ``axis`` is "UserDefined".
+
+    """
+
+    syc_name = "AddTransformation"
+
+    argument_names = [
+        "reference_frame",
+        "transformation_type",
+        "angle",
+        "axis",
+        "vector",
+    ]
+
+    class reference_frame(String):
+        """
+        Name of the reference frame to which the transformation will be added.
+        """
+
+        syc_name = "ReferenceFrame"
+
+    class transformation_type(String):
+        """
+        Type of transformation to be added. Available options are Rotation or
+        Translation
+
+        Required Parameters for Transformation Types:
+            Rotation: ``angle``, ``axis``, ``vector`` (if ``axis`` is \"UserDefined\")
+            Translation: ``vector``
+        """
+
+        syc_name = "TransformationType"
+
+    class angle(Real):
+        """
+        Angle to rotate a reference frame. Used with Rotation
+        ``transformation_type``. Default unit is Radians.
+        """
+
+        syc_name = "Angle"
+
+    class axis(String):
+        """
+        Axis about which a rotation is applied. Used with
+        Rotation ``transformation_type``. Available options are: "XAxis", "YAxis",
+        "ZAxis", and "UserDefined".
+        """
+
+        syc_name = "Axis"
+
+    class vector(RealVector):
+        """
+        A vector for use with Translation ``transformation_type`` or Rotation
+        ``transformation_type`` if the ``axis`` is "UserDefined".
+        """
+
+        syc_name = "Vector"

{ansys_systemcoupling_core-0.9.0 → ansys_systemcoupling_core-0.10.0}/src/ansys/systemcoupling/core/adaptor/api_25_2/analysis_control.py

@@ -79,6 +79,9 @@ class analysis_control(Container):
         ("check_for_input_files_changes", "CheckForInputFilesChanges", "str"),
         ("is_user_friendly_mapping", "IsUserFriendlyMapping", "bool"),
         ("reduce_informational_output", "ReduceInformationalOutput", "bool"),
+        ("participant_precision", "ParticipantPrecision", "str"),
+        ("avoid_rbf", "AvoidRBF", "str"),
+        ("interactive_initialization", "InteractiveInitialization", "bool"),
     ]
 
     @property
@@ -301,3 +304,30 @@ class analysis_control(Container):
     @reduce_informational_output.setter
     def reduce_informational_output(self, value: bool):
         self.set_property_state("reduce_informational_output", value)
+
+    @property
+    def participant_precision(self) -> str:
+        """Set global option for participant precision"""
+        return self.get_property_state("participant_precision")
+
+    @participant_precision.setter
+    def participant_precision(self, value: str):
+        self.set_property_state("participant_precision", value)
+
+    @property
+    def avoid_rbf(self) -> str:
+        """UNDOCUMENTED"""
+        return self.get_property_state("avoid_rbf")
+
+    @avoid_rbf.setter
+    def avoid_rbf(self, value: str):
+        self.set_property_state("avoid_rbf", value)
+
+    @property
+    def interactive_initialization(self) -> bool:
+        """Controls whether using interactive initialization for cosim"""
+        return self.get_property_state("interactive_initialization")
+
+    @interactive_initialization.setter
+    def interactive_initialization(self, value: bool):
+        self.set_property_state("interactive_initialization", value)

ansys_systemcoupling_core-0.10.0/src/ansys/systemcoupling/core/adaptor/api_25_2/attribute.py

@@ -0,0 +1,20 @@
+#
+# This is an auto-generated file.  DO NOT EDIT!
+#
+
+from ansys.systemcoupling.core.adaptor.impl.types import *
+
+from .attribute_child import attribute_child
+
+
+class attribute(NamedContainer[attribute_child]):
+    """
+    Configure an attribute.
+    """
+
+    syc_name = "Attribute"
+
+    child_object_type: attribute_child = attribute_child
+    """
+    child_object_type of attribute.
+    """

{ansys_systemcoupling_core-0.9.0 → ansys_systemcoupling_core-0.10.0}/src/ansys/systemcoupling/core/adaptor/api_25_2/attribute_child.py

@@ -9,7 +9,7 @@ from .dimensionality import dimensionality
 
 class attribute_child(Container):
     """
-    Configure a variable's attributes.
+    Configure an attribute.
     """
 
     syc_name = "child_object_type"
@@ -25,11 +25,12 @@ class attribute_child(Container):
         ("modifiable", "Modifiable", "bool"),
         ("real_value", "RealValue", "RealType"),
         ("integer_value", "IntegerValue", "int"),
+        ("string_value", "StringValue", "str"),
     ]
 
     @property
     def attribute_type(self) -> str:
-        """The type of the attribute (\"Real\" or \"Integer\")."""
+        """The type of the attribute (\"Real\", \"Integer\", or \"String\")."""
         return self.get_property_state("attribute_type")
 
     @attribute_type.setter
@@ -62,3 +63,12 @@ class attribute_child(Container):
     @integer_value.setter
     def integer_value(self, value: int):
         self.set_property_state("integer_value", value)
+
+    @property
+    def string_value(self) -> str:
+        """String attribute value."""
+        return self.get_property_state("string_value")
+
+    @string_value.setter
+    def string_value(self, value: str):
+        self.set_property_state("string_value", value)

{ansys_systemcoupling_core-0.9.0 → ansys_systemcoupling_core-0.10.0}/src/ansys/systemcoupling/core/adaptor/api_25_2/case_root.py

@@ -2,7 +2,7 @@
 # This is an auto-generated file.  DO NOT EDIT!
 #
 
-SHASH = "34d232b251e1d4a5a6b88e3deb9591863eac6afb1446228951276f9b1700da9f"
+SHASH = "959d876aeac97f5477abdc73030965f3b5cf57f93648d88535c634374191caa8"
 
 from ansys.systemcoupling.core.adaptor.impl.types import *
 

ansys_systemcoupling_core-0.10.0/src/ansys/systemcoupling/core/adaptor/api_25_2/create_restart_point.py

@@ -0,0 +1,28 @@
+#
+# This is an auto-generated file.  DO NOT EDIT!
+#
+
+from ansys.systemcoupling.core.adaptor.impl.types import *
+
+
+class create_restart_point(Command):
+    """
+    Interactive command that creates a restart point at the end of the
+    last completed coupling step.
+
+    Signals the System Coupling service and all coupling participants that a
+    restart point should be created before the next coupling step begins. The
+    restart point is created in addition to restart points created by the
+    '``output_control`` setting in the data model.
+
+    Note that some participants write their restart files only when the
+    coupling run resumes, so their files will not be available immediately
+    after the command is issued.
+
+    Results information for the coupling step is written to a file named
+    according to the convention ``Results_step<#>|iter<#>.h5``, where ``#`` is the number of
+    the coupling step or iteration. The restart files are written to the "SyC"
+    directory, which is automatically created by System Coupling.
+    """
+
+    syc_name = "CreateRestartPoint"