ansys-systemcoupling-core 0.4.dev0__py3-none-any.whl → 0.5.0__py3-none-any.whl

ansys/systemcoupling/core/__init__.py

@@ -29,6 +29,8 @@ from ansys.systemcoupling.core.client.grpc_client import SycGrpc
 from ansys.systemcoupling.core.session import Session
 from ansys.systemcoupling.core.util.logging import LOG
 
+import ansys.platform.instancemanagement as pypim
+
 try:
     import importlib.metadata as importlib_metadata
 except ModuleNotFoundError:  # pragma: no cover
@@ -87,14 +89,21 @@ def launch(
         remote System Coupling instance.
     """
     rpc = SycGrpc()
-    rpc.start_and_connect(
-        port=port,
-        working_dir=working_dir,
-        nprocs=nprocs,
-        sycnprocs=sycnprocs,
-        version=version,
-        extra_args=extra_args,
-    )
+    if pypim.is_configured():
+        LOG.info(
+            "Starting System Coupling remotely. Any launch arguments other "
+            "than 'version' are ignored."
+        )
+        rpc.start_pim_and_connect(version)
+    else:
+        rpc.start_and_connect(
+            port=port,
+            working_dir=working_dir,
+            nprocs=nprocs,
+            sycnprocs=sycnprocs,
+            version=version,
+            extra_args=extra_args,
+        )
     return Session(rpc)
 
 
@@ -121,6 +130,33 @@ def launch_container(
     return Session(rpc)
 
 
+def launch_remote(
+    version: str = None,
+) -> Session:
+    """Launch System Coupling remotely using `PyPIM <https://pypim.docs.pyansys.com>`.
+
+    When calling this function, you must ensure that you are in an
+    environment where ``PyPIM`` is configured. You can use the :func:
+    `pypim.is_configured <ansys.platform.instancemanagement.is_configured>`
+    method to verify that ``PyPIM`` is configured.
+
+    Parameters
+    ----------
+    version : str, optional
+        The System Coupling product version. See :func:`launch<core.launch>`
+        for details of supported version strings.
+
+    Returns
+    -------
+    ansys.systemcoupling.core.session.Session
+        Session object, providing access to a set up and solve API controlling a
+        remote System Coupling instance.
+    """
+    rpc = SycGrpc()
+    rpc.start_pim_and_connect(version)
+    return Session(rpc)
+
+
 def connect(host: str, port: int) -> Session:  # pragma: no cover
     """Connect to an instance of System Coupling already running in server mode.
 

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/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/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/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/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/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/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/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/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"

ansys/systemcoupling/core/adaptor/api_24_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/adaptor/api_24_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/adaptor/api_24_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/adaptor/api_24_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/adaptor/api_24_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/adaptor/api_24_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 : typing.List[str], 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"