ansys-systemcoupling-core 0.9.1__tar.gz → 0.10.1__tar.gz

{ansys_systemcoupling_core-0.9.1 → ansys_systemcoupling_core-0.10.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ansys-systemcoupling-core
-Version: 0.9.1
+Version: 0.10.1
 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.4.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.2.0 ; 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"
@@ -137,25 +138,30 @@ in this order:
 
 * ``SYSC_ROOT``
 * ``AWP_ROOT``
-* ``AWP_ROOT251``
+* ``AWP_ROOT252``
 
 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_ROOT251`` is set.
+In a standard user installation, the expectation is that only ``AWP_ROOT252`` 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**
 
+   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.1 → ansys_systemcoupling_core-0.10.1}/README.rst

@@ -73,25 +73,30 @@ in this order:
 
 * ``SYSC_ROOT``
 * ``AWP_ROOT``
-* ``AWP_ROOT251``
+* ``AWP_ROOT252``
 
 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_ROOT251`` is set.
+In a standard user installation, the expectation is that only ``AWP_ROOT252`` 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**
 
+   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.1 → ansys_systemcoupling_core-0.10.1}/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.1"
+version = "0.10.1"
 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.4.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.2.0",
+	"flake8==7.3.0",
 ]
 tests = [
 	"pytest",

{ansys_systemcoupling_core-0.9.1 → ansys_systemcoupling_core-0.10.1}/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.10.1/src/ansys/systemcoupling/core/adaptor/api_25_2/_add_participant.py

@@ -0,0 +1,80 @@
+#
+# This is an auto-generated file.  DO NOT EDIT!
+#
+
+from ansys.systemcoupling.core.adaptor.impl.types import *
+
+
+class _add_participant(Command):
+    """
+    For internal use only.
+
+    Parameters
+    ----------
+    participant_type : str, optional
+        ...
+    input_file : str, optional
+        ...
+    executable : str, optional
+        ...
+    additional_arguments : str, optional
+        ...
+    working_directory : str, optional
+        ...
+    python_script : str, optional
+        ...
+
+    """
+
+    syc_name = "AddParticipant"
+
+    argument_names = [
+        "participant_type",
+        "input_file",
+        "executable",
+        "additional_arguments",
+        "working_directory",
+        "python_script",
+    ]
+
+    class participant_type(String):
+        """
+        ...
+        """
+
+        syc_name = "ParticipantType"
+
+    class input_file(String):
+        """
+        ...
+        """
+
+        syc_name = "InputFile"
+
+    class executable(String):
+        """
+        ...
+        """
+
+        syc_name = "Executable"
+
+    class additional_arguments(String):
+        """
+        ...
+        """
+
+        syc_name = "AdditionalArguments"
+
+    class working_directory(String):
+        """
+        ...
+        """
+
+        syc_name = "WorkingDirectory"
+
+    class python_script(String):
+        """
+        ...
+        """
+
+        syc_name = "PythonScript"

ansys_systemcoupling_core-0.10.1/src/ansys/systemcoupling/core/adaptor/api_25_2/_clear_state.py

@@ -0,0 +1,13 @@
+#
+# This is an auto-generated file.  DO NOT EDIT!
+#
+
+from ansys.systemcoupling.core.adaptor.impl.types import *
+
+
+class _clear_state(Command):
+    """
+    For internal use only.
+    """
+
+    syc_name = "ClearState"

ansys_systemcoupling_core-0.10.1/src/ansys/systemcoupling/core/adaptor/api_25_2/_solve.py

@@ -0,0 +1,13 @@
+#
+# This is an auto-generated file.  DO NOT EDIT!
+#
+
+from ansys.systemcoupling.core.adaptor.impl.types import *
+
+
+class _solve(Command):
+    """
+    For internal use only.
+    """
+
+    syc_name = "Solve"

ansys_systemcoupling_core-0.10.1/src/ansys/systemcoupling/core/adaptor/api_25_2/abort.py

@@ -0,0 +1,39 @@
+#
+# This is an auto-generated file.  DO NOT EDIT!
+#
+
+from ansys.systemcoupling.core.adaptor.impl.types import *
+
+
+class abort(InjectedCommand):
+    """
+    Aborts a solve in progress.
+
+    See also ``interrupt``. In contrast to an interrupted solve,
+    an aborted solve cannot be resumed.
+
+    Parameters
+    ----------
+    reason_msg : str, optional
+        Text to describe the reason for the abort.
+
+        This might be used for such purposes as providing
+        additional annotation in transcript output.
+
+    """
+
+    syc_name = "abort"
+
+    cmd_name = "abort"
+
+    argument_names = ["reason_msg"]
+
+    class reason_msg(String):
+        """
+        Text to describe the reason for the abort.
+
+        This might be used for such purposes as providing
+        additional annotation in transcript output.
+        """
+
+        syc_name = "reason_msg"

ansys_systemcoupling_core-0.10.1/src/ansys/systemcoupling/core/adaptor/api_25_2/activate_hidden.py

@@ -0,0 +1,46 @@
+#
+# This is an auto-generated file.  DO NOT EDIT!
+#
+
+from ansys.systemcoupling.core.adaptor.impl.types import *
+
+
+class activate_hidden(Container):
+    """
+    Contains settings to control exposure of hidden features.
+    """
+
+    syc_name = "ActivateHidden"
+
+    property_names_types = [
+        ("beta_features", "BetaFeatures", "bool"),
+        ("alpha_features", "AlphaFeatures", "bool"),
+        ("lenient_validation", "LenientValidation", "bool"),
+    ]
+
+    @property
+    def beta_features(self) -> bool:
+        """Turn on exposure of Beta features."""
+        return self.get_property_state("beta_features")
+
+    @beta_features.setter
+    def beta_features(self, value: bool):
+        self.set_property_state("beta_features", value)
+
+    @property
+    def alpha_features(self) -> bool:
+        """Turn on exposure of Alpha features. (Beta features must be turned on first)"""
+        return self.get_property_state("alpha_features")
+
+    @alpha_features.setter
+    def alpha_features(self, value: bool):
+        self.set_property_state("alpha_features", value)
+
+    @property
+    def lenient_validation(self) -> bool:
+        """Allow a case with zero participants and zero coupling interfaces to be set up."""
+        return self.get_property_state("lenient_validation")
+
+    @lenient_validation.setter
+    def lenient_validation(self, value: bool):
+        self.set_property_state("lenient_validation", value)

ansys_systemcoupling_core-0.10.1/src/ansys/systemcoupling/core/adaptor/api_25_2/add_aerodamping_data_transfers.py

@@ -0,0 +1,43 @@
+#
+# This is an auto-generated file.  DO NOT EDIT!
+#
+
+from ansys.systemcoupling.core.adaptor.impl.types import *
+
+
+class add_aerodamping_data_transfers(Command):
+    """
+    Adds data transfer for each specified mode shape.
+
+    Returns the name of the Data Transfers created.
+
+    Parameters
+    ----------
+    interface : str
+        String indicating the name of the interface on which the data transfer
+        is to be created.
+    mode_shapes : List, optional
+        List of mode shapes to transfer. If not provided, a
+        data transfer is created for each available modeshape.
+
+    """
+
+    syc_name = "AddAerodampingDataTransfers"
+
+    argument_names = ["interface", "mode_shapes"]
+
+    class interface(String):
+        """
+        String indicating the name of the interface on which the data transfer
+        is to be created.
+        """
+
+        syc_name = "Interface"
+
+    class mode_shapes(StringList):
+        """
+        List of mode shapes to transfer. If not provided, a
+        data transfer is created for each available modeshape.
+        """
+
+        syc_name = "ModeShapes"

ansys_systemcoupling_core-0.10.1/src/ansys/systemcoupling/core/adaptor/api_25_2/add_data_transfer.py

@@ -0,0 +1,190 @@
+#
+# This is an auto-generated file.  DO NOT EDIT!
+#
+
+from ansys.systemcoupling.core.adaptor.impl.types import *
+
+
+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, 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 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.
+
+    Cannot be run after participants have been started.
+
+    Returns the name of the Data Transfer created.
+
+    Parameters
+    ----------
+    interface : str
+        String indicating the name of the interface on which the data transfer
+        is to be created.
+    target_side : str
+        String indicating the side of the interface to receive the data
+        transfer variable. Possible values are \"One\" or \"Two\".
+    source_variable : str, optional
+        String specifying the name of the variable on the source side of
+        the data transfer. Used when creating a variable-based data transfer.
+        Must be combined with ``target_variable``.
+    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_{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
+        ``target_variable`` is a vector, a vector-valued expression must be provided.
+        Alternatively, ``value_x``, ``value_y``, ``value_z`` may be used to specify the
+        individual components of the vector expression.
+    value_x : str, optional
+        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
+        ``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
+        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_x`` and
+        ``value_z`` are also required if ``value_y`` is used.
+    value_z : str, optional
+        String specifying the Z 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_x`` and
+        ``value_y`` are also required if ``value_z`` is used.
+    side_one_variable : str, optional
+        String specifying the name of the variable associated with side1
+        of the interface. Must be combined with ``side_two_variable``. Used only
+        when creating variable-based data transfers. Consider using
+        ``source_variable``/``target_variable`` parameters instead.
+    side_two_variable : str, optional
+        String specifying the name of the variable associated with side2
+        of the interface. Must be combined with ``side_two_variable``. Used only
+        when creating variable-based data transfers. Consider using
+        ``source_variable``/``target_variable`` parameters instead.
+
+    """
+
+    syc_name = "AddDataTransfer"
+
+    argument_names = [
+        "interface",
+        "target_side",
+        "source_variable",
+        "target_variable",
+        "value",
+        "value_x",
+        "value_y",
+        "value_z",
+        "side_one_variable",
+        "side_two_variable",
+    ]
+
+    class interface(String):
+        """
+        String indicating the name of the interface on which the data transfer
+        is to be created.
+        """
+
+        syc_name = "Interface"
+
+    class target_side(String):
+        """
+        String indicating the side of the interface to receive the data
+        transfer variable. Possible values are \"One\" or \"Two\".
+        """
+
+        syc_name = "TargetSide"
+
+    class source_variable(String):
+        """
+        String specifying the name of the variable on the source side of
+        the data transfer. Used when creating a variable-based data transfer.
+        Must be combined with ``target_variable``.
+        """
+
+        syc_name = "SourceVariable"
+
+    class target_variable(String):
+        """
+        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_{x|y|z}``
+        (when creating an expression-based data transfer).
+        """
+
+        syc_name = "TargetVariable"
+
+    class value(String):
+        """
+        String specifying the expression to use on the source side of the data
+        transfer. Used when creating an expression-based data transfer. If the
+        ``target_variable`` is a vector, a vector-valued expression must be provided.
+        Alternatively, ``value_x``, ``value_y``, ``value_z`` may be used to specify the
+        individual components of the vector expression.
+        """
+
+        syc_name = "Value"
+
+    class value_x(String):
+        """
+        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
+        ``value_z`` are also required if ``value_x`` is used.
+        """
+
+        syc_name = "ValueX"
+
+    class value_y(String):
+        """
+        String specifying the Y 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_x`` and
+        ``value_z`` are also required if ``value_y`` is used.
+        """
+
+        syc_name = "ValueY"
+
+    class value_z(String):
+        """
+        String specifying the Z 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_x`` and
+        ``value_y`` are also required if ``value_z`` is used.
+        """
+
+        syc_name = "ValueZ"
+
+    class side_one_variable(String):
+        """
+        String specifying the name of the variable associated with side1
+        of the interface. Must be combined with ``side_two_variable``. Used only
+        when creating variable-based data transfers. Consider using
+        ``source_variable``/``target_variable`` parameters instead.
+        """
+
+        syc_name = "SideOneVariable"
+
+    class side_two_variable(String):
+        """
+        String specifying the name of the variable associated with side2
+        of the interface. Must be combined with ``side_two_variable``. Used only
+        when creating variable-based data transfers. Consider using
+        ``source_variable``/``target_variable`` parameters instead.
+        """
+
+        syc_name = "SideTwoVariable"

ansys_systemcoupling_core-0.10.1/src/ansys/systemcoupling/core/adaptor/api_25_2/add_expression_function.py

@@ -0,0 +1,61 @@
+#
+# This is an auto-generated file.  DO NOT EDIT!
+#
+
+from ansys.systemcoupling.core.adaptor.impl.types import *
+
+
+class add_expression_function(Command):
+    """
+    Creates an expression function object in the data model that makes
+    available an external Python function for use in expressions.
+
+    The parameters specified should correspond to a module and function
+    that exists and can successfully be loaded when the application
+    starts. Otherwise, the data model object will be created but there
+    will be validation errors and the function will not be available for
+    use.
+
+    Parameters
+    ----------
+    module : str
+        The name of the Python module (in the 'Modules' sub-directory of
+        the working directory) from which the function is to be obtained.
+    function : str
+        The name of the function in the module. If no ``function_name`` is
+        specified, this will also be the name by which the function should
+        be referenced when used in an expression.
+    function_name : str, optional
+        Optionally specify a different name from ``function`` which should be
+        the name used to reference the function in an expression.
+
+    """
+
+    syc_name = "AddExpressionFunction"
+
+    argument_names = ["module", "function", "function_name"]
+
+    class module(String):
+        """
+        The name of the Python module (in the 'Modules' sub-directory of
+        the working directory) from which the function is to be obtained.
+        """
+
+        syc_name = "Module"
+
+    class function(String):
+        """
+        The name of the function in the module. If no ``function_name`` is
+        specified, this will also be the name by which the function should
+        be referenced when used in an expression.
+        """
+
+        syc_name = "Function"
+
+    class function_name(String):
+        """
+        Optionally specify a different name from ``function`` which should be
+        the name used to reference the function in an expression.
+        """
+
+        syc_name = "FunctionName"