ansys-systemcoupling-core 0.4.1__tar.gz → 0.6__tar.gz

{ansys_systemcoupling_core-0.4.1 → ansys_systemcoupling_core-0.6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: ansys-systemcoupling-core
-Version: 0.4.1
+Version: 0.6
 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,34 +20,35 @@ Classifier: Programming Language :: Python :: 3.12
 Requires-Dist: ansys-api-systemcoupling==0.1.0
 Requires-Dist: ansys-platform-instancemanagement~=1.0
 Requires-Dist: grpcio>=1.30.0
-Requires-Dist: grpcio-status>=1.30.0,<1.60.2
+Requires-Dist: grpcio-status>=1.30.0,<1.64.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.1.1 ; extra == "classesgen"
+Requires-Dist: black==24.4.2 ; extra == "classesgen"
 Requires-Dist: isort==5.13.2 ; extra == "classesgen"
-Requires-Dist: ansys-sphinx-theme==0.13.3 ; extra == "doc"
+Requires-Dist: ansys-sphinx-theme==0.16.6 ; extra == "doc"
 Requires-Dist: jupyter_sphinx==0.5.3 ; extra == "doc"
 Requires-Dist: matplotlib ; 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==2024.2.4 ; extra == "doc"
-Requires-Dist: sphinx-autodoc-typehints==1.25.2 ; extra == "doc"
+Requires-Dist: numpydoc==1.7.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-autobuild==2024.4.16 ; extra == "doc"
+Requires-Dist: sphinx-autodoc-typehints==2.2.2 ; extra == "doc"
 Requires-Dist: sphinx-copybutton==0.5.2 ; extra == "doc"
-Requires-Dist: sphinx-gallery==0.15.0 ; extra == "doc"
-Requires-Dist: sphinx-notfound-page==1.0.0 ; 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: sphinxemoji==0.3.1 ; extra == "doc"
 Requires-Dist: ansys-fluent-core ; extra == "doc"
 Requires-Dist: ansys-dpf-core ; extra == "doc"
-Requires-Dist: codespell==2.2.6 ; extra == "style"
-Requires-Dist: flake8==7.0.0 ; extra == "style"
+Requires-Dist: codespell==2.3.0 ; extra == "style"
+Requires-Dist: flake8==7.1.0 ; extra == "style"
 Requires-Dist: pytest ; extra == "tests"
 Requires-Dist: pytest-cov ; extra == "tests"
 Requires-Dist: psutil>=5.7.0 ; extra == "tests"
@@ -136,12 +137,12 @@ in this order:
 
 * ``SYSC_ROOT``
 * ``AWP_ROOT``
-* ``AWP_ROOT241``
+* ``AWP_ROOT242``
 
 If a variable is set but does not refer to a valid installation, PySystemCoupling
 fails at that point, rather than attempting to use the next variable.
 
-In a standard user installation, the expectation is that only ``AWP_ROOT241`` is set.
+In a standard user installation, the expectation is that only ``AWP_ROOT242`` is set.
 
 (It is also possible to provide a different version number as an argument to the ``launch()``
 function. This will affect which ``AWP_ROOT<version>`` environment variable is examined.)

{ansys_systemcoupling_core-0.4.1 → ansys_systemcoupling_core-0.6}/README.rst

@@ -73,12 +73,12 @@ in this order:
 
 * ``SYSC_ROOT``
 * ``AWP_ROOT``
-* ``AWP_ROOT241``
+* ``AWP_ROOT242``
 
 If a variable is set but does not refer to a valid installation, PySystemCoupling
 fails at that point, rather than attempting to use the next variable.
 
-In a standard user installation, the expectation is that only ``AWP_ROOT241`` is set.
+In a standard user installation, the expectation is that only ``AWP_ROOT242`` is set.
 
 (It is also possible to provide a different version number as an argument to the ``launch()``
 function. This will affect which ``AWP_ROOT<version>`` environment variable is examined.)

{ansys_systemcoupling_core-0.4.1 → ansys_systemcoupling_core-0.6}/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.4.1"
+version = "0.6"
 description = "A Python wrapper for Ansys System Coupling."
 readme = "README.rst"
 requires-python = ">=3.9,<3.13"
@@ -20,13 +20,14 @@ dependencies = [
 	"ansys-api-systemcoupling==0.1.0",
         "ansys-platform-instancemanagement~=1.0",
 	"grpcio>=1.30.0",
-	"grpcio-status>=1.30.0,<1.60.2",
+	"grpcio-status>=1.30.0,<1.64.2",
 	"googleapis-common-protos>=1.50.0",
 	"protobuf>=3.20.1,<4.0.0",
 	"psutil>=5.7.0",
 	"pyyaml",
 	"appdirs>=1.4.0",
 	"importlib-metadata>=4.0",
+	"matplotlib>=3.8.2",
 ]
 classifiers = [
     "Development Status :: 4 - Beta",
@@ -51,24 +52,24 @@ classesgen = [
 
 	# NB
 	# black and isort are called programmatically to keep generated code
-	# consistent with style elsewhere. We need to keep the versions in
+	# consistent with style elsewhere. We need to keep these versions in
 	# sync with the precommit dependencies.
-	"black==24.1.1",
+	"black==24.4.2",
 	"isort==5.13.2",
 ]
 doc = [
-	"ansys-sphinx-theme==0.13.3",
+	"ansys-sphinx-theme==0.16.6",
 	"jupyter_sphinx==0.5.3",
 	"matplotlib",
-	"numpydoc==1.6.0",
-	"pypandoc==1.12",
-	"pytest-sphinx==0.6.0",
-	"Sphinx==7.2.6",
-	"sphinx-autobuild==2024.2.4",
-	"sphinx-autodoc-typehints==1.25.2",
+	"numpydoc==1.7.0",
+	"pypandoc==1.13",
+	"pytest-sphinx==0.6.3",
+	"Sphinx==7.3.7",
+	"sphinx-autobuild==2024.4.16",
+	"sphinx-autodoc-typehints==2.2.2",
 	"sphinx-copybutton==0.5.2",
-	"sphinx-gallery==0.15.0",
-	"sphinx-notfound-page==1.0.0",
+	"sphinx-gallery==0.16.0",
+	"sphinx-notfound-page==1.0.2",
 	"sphinxcontrib-websupport==1.2.7",
 	"sphinxemoji==0.3.1",
 
@@ -77,8 +78,9 @@ doc = [
 	"ansys-dpf-core",
 ]
 style = [
-	"codespell==2.2.6",
-	"flake8==7.0.0",
+	# NB: ensure these remain synced with .pre-commit-config.yaml
+	"codespell==2.3.0",
+	"flake8==7.1.0",
 ]
 tests = [
 	"pytest",

{ansys_systemcoupling_core-0.4.1 → ansys_systemcoupling_core-0.6}/src/ansys/systemcoupling/core/__init__.py

@@ -46,6 +46,7 @@ def launch(
     nprocs: int = None,
     sycnprocs: int = None,
     version: str = None,
+    start_output: bool = False,
     extra_args: List[str] = [],
 ) -> Session:
     """Start a local instance of System Coupling and connect to it.
@@ -67,13 +68,17 @@ def launch(
         ``None``, in which case the System Coupling server uses its own default.
     version : str, optional
         String specifying the version of System Coupling to use. For example,
-        to use System Coupling from the Ansys "2023 R1" release, specify ``"231"``.
-        (The forms ``"23.1"`` and ``"23_1"`` are also acceptable.)
+        to use System Coupling from the Ansys "2024 R1" release, specify ``"241"``.
+        (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
-        ``"241"`` ("2024 R1" release), unless either of the environment
+        ``"242"`` ("2024 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
+        Boolean to specify if the user wants to stream system coupling output.
+        The default is ``False``, in which case the output stream is kept hidden.
+        If ``True``, the output information is printed to standard output.
     extra_args : List[str]
         List of any additional arguments to specify when the server
         process is launched. The default is ``[]``. If a list of additional
@@ -92,9 +97,9 @@ def launch(
     if pypim.is_configured():
         LOG.info(
             "Starting System Coupling remotely. Any launch arguments other "
-            "than 'version' are ignored."
+            "than 'version' and 'start_output' are ignored."
         )
-        rpc.start_pim_and_connect(version)
+        rpc.start_pim_and_connect(version, start_output)
     else:
         rpc.start_and_connect(
             port=port,
@@ -102,6 +107,7 @@ def launch(
             nprocs=nprocs,
             sycnprocs=sycnprocs,
             version=version,
+            start_output=start_output,
             extra_args=extra_args,
         )
     return Session(rpc)

ansys_systemcoupling_core-0.6/src/ansys/systemcoupling/core/adaptor/api_23_1/_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.4.1/src/ansys/systemcoupling/core/adaptor/api_23_2 → ansys_systemcoupling_core-0.6/src/ansys/systemcoupling/core/adaptor/api_23_1}/case_root.py

@@ -2,10 +2,11 @@
 # This is an auto-generated file.  DO NOT EDIT!
 #
 
-SHASH = "0fbfd3e7593591d8e52193a6e92828c6174e531b26437aee17285b3d0d114664"
+SHASH = "c6427eb39292f21707811cf7093268eb2b0d3d9f2780ddaf390bf51bb916e546"
 
 from ansys.systemcoupling.core.adaptor.impl.types import *
 
+from ._clear_state import _clear_state
 from .clear_state import clear_state
 from .delete_snapshot import delete_snapshot
 from .get_snapshots import get_snapshots
@@ -23,6 +24,7 @@ class case_root(Container):
     syc_name = "CaseCommands"
 
     command_names = [
+        "_clear_state",
         "clear_state",
         "delete_snapshot",
         "get_snapshots",
@@ -32,6 +34,10 @@ class case_root(Container):
         "save_snapshot",
     ]
 
+    _clear_state: _clear_state = _clear_state
+    """
+    _clear_state command of case_root.
+    """
     clear_state: clear_state = clear_state
     """
     clear_state command of case_root.

{ansys_systemcoupling_core-0.4.1/src/ansys/systemcoupling/core/adaptor/api_23_2 → ansys_systemcoupling_core-0.6/src/ansys/systemcoupling/core/adaptor/api_23_1}/clear_state.py

@@ -5,7 +5,7 @@
 from ansys.systemcoupling.core.adaptor.impl.types import *
 
 
-class clear_state(Command):
+class clear_state(InjectedCommand):
     """
     Clears the state of the entire System Coupling service, removing all
     data model items, parameter values, and calculated values.
@@ -13,4 +13,6 @@ class clear_state(Command):
     Cannot be run after participants have been started.
     """
 
-    syc_name = "ClearState"
+    syc_name = "clear_state"
+
+    cmd_name = "clear_state"

ansys_systemcoupling_core-0.6/src/ansys/systemcoupling/core/adaptor/api_23_1/show_plot.py

@@ -0,0 +1,75 @@
+#
+# This is an auto-generated file.  DO NOT EDIT!
+#
+
+from ansys.systemcoupling.core.adaptor.impl.types import *
+
+
+class show_plot(InjectedCommand):
+    """
+    Shows plots of transfer values and convergence for data transfers
+    of a coupling interface.
+
+    Parameters
+    ----------
+    interface_name : str
+        Specification of which interface to plot.
+    transfer_names : typing.List[str], optional
+        Specification of which data transfers to plot. Defaults
+        to ``None``, which means plot all data transfers.
+    working_dir : str, optional
+        Working directory (defaults = ".").
+    show_convergence : bool, optional
+        Whether to show convergence plots (defaults to ``True``).
+    show_transfer_values : bool, optional
+        Whether to show transfer value plots (defaults to ``True``).
+
+    """
+
+    syc_name = "show_plot"
+
+    cmd_name = "show_plot"
+
+    argument_names = [
+        "interface_name",
+        "transfer_names",
+        "working_dir",
+        "show_convergence",
+        "show_transfer_values",
+    ]
+
+    class interface_name(String):
+        """
+        Specification of which interface to plot.
+        """
+
+        syc_name = "interface_name"
+
+    class transfer_names(StringList):
+        """
+        Specification of which data transfers to plot. Defaults
+        to ``None``, which means plot all data transfers.
+        """
+
+        syc_name = "transfer_names"
+
+    class working_dir(String):
+        """
+        Working directory (defaults = ".").
+        """
+
+        syc_name = "working_dir"
+
+    class show_convergence(Boolean):
+        """
+        Whether to show convergence plots (defaults to ``True``).
+        """
+
+        syc_name = "show_convergence"
+
+    class show_transfer_values(Boolean):
+        """
+        Whether to show transfer value plots (defaults to ``True``).
+        """
+
+        syc_name = "show_transfer_values"

{ansys_systemcoupling_core-0.4.1 → ansys_systemcoupling_core-0.6}/src/ansys/systemcoupling/core/adaptor/api_23_1/solution_root.py

@@ -2,7 +2,7 @@
 # This is an auto-generated file.  DO NOT EDIT!
 #
 
-SHASH = "54b4aa678f0aea8cebeca86bcd71b2877e846e53079c2bf52974d5e039ed3719"
+SHASH = "2774672445bd1c461a14acd1d3f26dcc93710777fea4556f16e3a79c35e271c9"
 
 from ansys.systemcoupling.core.adaptor.impl.types import *
 
@@ -14,6 +14,7 @@ from .initialize import initialize
 from .interrupt import interrupt
 from .open_results_in_ensight import open_results_in_ensight
 from .partition_participants import partition_participants
+from .show_plot import show_plot
 from .shutdown import shutdown
 from .solve import solve
 from .start_participants import start_participants
@@ -38,6 +39,7 @@ class solution_root(Container):
         "interrupt",
         "open_results_in_ensight",
         "partition_participants",
+        "show_plot",
         "shutdown",
         "solve",
         "start_participants",
@@ -78,6 +80,10 @@ class solution_root(Container):
     """
     partition_participants command of solution_root.
     """
+    show_plot: show_plot = show_plot
+    """
+    show_plot command of solution_root.
+    """
     shutdown: shutdown = shutdown
     """
     shutdown command of solution_root.

ansys_systemcoupling_core-0.6/src/ansys/systemcoupling/core/adaptor/api_23_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.4.1/src/ansys/systemcoupling/core/adaptor/api_23_1 → ansys_systemcoupling_core-0.6/src/ansys/systemcoupling/core/adaptor/api_23_2}/case_root.py

@@ -2,10 +2,11 @@
 # This is an auto-generated file.  DO NOT EDIT!
 #
 
-SHASH = "0fbfd3e7593591d8e52193a6e92828c6174e531b26437aee17285b3d0d114664"
+SHASH = "c6427eb39292f21707811cf7093268eb2b0d3d9f2780ddaf390bf51bb916e546"
 
 from ansys.systemcoupling.core.adaptor.impl.types import *
 
+from ._clear_state import _clear_state
 from .clear_state import clear_state
 from .delete_snapshot import delete_snapshot
 from .get_snapshots import get_snapshots
@@ -23,6 +24,7 @@ class case_root(Container):
     syc_name = "CaseCommands"
 
     command_names = [
+        "_clear_state",
         "clear_state",
         "delete_snapshot",
         "get_snapshots",
@@ -32,6 +34,10 @@ class case_root(Container):
         "save_snapshot",
     ]
 
+    _clear_state: _clear_state = _clear_state
+    """
+    _clear_state command of case_root.
+    """
     clear_state: clear_state = clear_state
     """
     clear_state command of case_root.

{ansys_systemcoupling_core-0.4.1/src/ansys/systemcoupling/core/adaptor/api_23_1 → ansys_systemcoupling_core-0.6/src/ansys/systemcoupling/core/adaptor/api_23_2}/clear_state.py

@@ -5,7 +5,7 @@
 from ansys.systemcoupling.core.adaptor.impl.types import *
 
 
-class clear_state(Command):
+class clear_state(InjectedCommand):
     """
     Clears the state of the entire System Coupling service, removing all
     data model items, parameter values, and calculated values.
@@ -13,4 +13,6 @@ class clear_state(Command):
     Cannot be run after participants have been started.
     """
 
-    syc_name = "ClearState"
+    syc_name = "clear_state"
+
+    cmd_name = "clear_state"

ansys_systemcoupling_core-0.6/src/ansys/systemcoupling/core/adaptor/api_23_2/show_plot.py

@@ -0,0 +1,75 @@
+#
+# This is an auto-generated file.  DO NOT EDIT!
+#
+
+from ansys.systemcoupling.core.adaptor.impl.types import *
+
+
+class show_plot(InjectedCommand):
+    """
+    Shows plots of transfer values and convergence for data transfers
+    of a coupling interface.
+
+    Parameters
+    ----------
+    interface_name : str
+        Specification of which interface to plot.
+    transfer_names : typing.List[str], optional
+        Specification of which data transfers to plot. Defaults
+        to ``None``, which means plot all data transfers.
+    working_dir : str, optional
+        Working directory (defaults = ".").
+    show_convergence : bool, optional
+        Whether to show convergence plots (defaults to ``True``).
+    show_transfer_values : bool, optional
+        Whether to show transfer value plots (defaults to ``True``).
+
+    """
+
+    syc_name = "show_plot"
+
+    cmd_name = "show_plot"
+
+    argument_names = [
+        "interface_name",
+        "transfer_names",
+        "working_dir",
+        "show_convergence",
+        "show_transfer_values",
+    ]
+
+    class interface_name(String):
+        """
+        Specification of which interface to plot.
+        """
+
+        syc_name = "interface_name"
+
+    class transfer_names(StringList):
+        """
+        Specification of which data transfers to plot. Defaults
+        to ``None``, which means plot all data transfers.
+        """
+
+        syc_name = "transfer_names"
+
+    class working_dir(String):
+        """
+        Working directory (defaults = ".").
+        """
+
+        syc_name = "working_dir"
+
+    class show_convergence(Boolean):
+        """
+        Whether to show convergence plots (defaults to ``True``).
+        """
+
+        syc_name = "show_convergence"
+
+    class show_transfer_values(Boolean):
+        """
+        Whether to show transfer value plots (defaults to ``True``).
+        """
+
+        syc_name = "show_transfer_values"

{ansys_systemcoupling_core-0.4.1 → ansys_systemcoupling_core-0.6}/src/ansys/systemcoupling/core/adaptor/api_23_2/solution_root.py

@@ -2,7 +2,7 @@
 # This is an auto-generated file.  DO NOT EDIT!
 #
 
-SHASH = "9d14945e18aa7dc6f7ad86397c62f0ceb910440e6ac3753ce8a1d0d2f91b84f5"
+SHASH = "a713a451f17d724fabb76832c57ba91cb2d9a7426f9cd3be60bb1a03197d351a"
 
 from ansys.systemcoupling.core.adaptor.impl.types import *
 
@@ -15,6 +15,7 @@ from .initialize import initialize
 from .interrupt import interrupt
 from .open_results_in_en_sight import open_results_in_en_sight
 from .partition_participants import partition_participants
+from .show_plot import show_plot
 from .shutdown import shutdown
 from .solve import solve
 from .start_participants import start_participants
@@ -40,6 +41,7 @@ class solution_root(Container):
         "interrupt",
         "open_results_in_en_sight",
         "partition_participants",
+        "show_plot",
         "shutdown",
         "solve",
         "start_participants",
@@ -84,6 +86,10 @@ class solution_root(Container):
     """
     partition_participants command of solution_root.
     """
+    show_plot: show_plot = show_plot
+    """
+    show_plot command of solution_root.
+    """
     shutdown: shutdown = shutdown
     """
     shutdown command of solution_root.

ansys_systemcoupling_core-0.6/src/ansys/systemcoupling/core/adaptor/api_24_1/_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.4.1 → ansys_systemcoupling_core-0.6}/src/ansys/systemcoupling/core/adaptor/api_24_1/case_root.py

@@ -2,10 +2,11 @@
 # This is an auto-generated file.  DO NOT EDIT!
 #
 
-SHASH = "430648f7df949b91819d62a5c2d5a5c49d1d67217fb3474ee31e0c78e5ffbd43"
+SHASH = "34d232b251e1d4a5a6b88e3deb9591863eac6afb1446228951276f9b1700da9f"
 
 from ansys.systemcoupling.core.adaptor.impl.types import *
 
+from ._clear_state import _clear_state
 from .clear_state import clear_state
 from .delete_snapshot import delete_snapshot
 from .open import open
@@ -22,6 +23,7 @@ class case_root(Container):
     syc_name = "CaseCommands"
 
     command_names = [
+        "_clear_state",
         "clear_state",
         "delete_snapshot",
         "open",
@@ -30,6 +32,10 @@ class case_root(Container):
         "save_snapshot",
     ]
 
+    _clear_state: _clear_state = _clear_state
+    """
+    _clear_state command of case_root.
+    """
     clear_state: clear_state = clear_state
     """
     clear_state command of case_root.

{ansys_systemcoupling_core-0.4.1 → ansys_systemcoupling_core-0.6}/src/ansys/systemcoupling/core/adaptor/api_24_1/clear_state.py

@@ -5,7 +5,7 @@
 from ansys.systemcoupling.core.adaptor.impl.types import *
 
 
-class clear_state(Command):
+class clear_state(InjectedCommand):
     """
     Clears the state of the entire System Coupling service, removing all
     data model items, parameter values, and calculated values.
@@ -13,4 +13,6 @@ class clear_state(Command):
     Cannot be run after participants have been started.
     """
 
-    syc_name = "ClearState"
+    syc_name = "clear_state"
+
+    cmd_name = "clear_state"