feat: Feat/add local launcher

doc/changelog.d/454.added.md

@@ -0,0 +1 @@
+Feat/add local launcher

pyproject.toml

@@ -31,6 +31,7 @@ dependencies=[
     "grpcio>=1.50.0,<1.71",
     "grpcio-health-checking>=1.45.0,<1.68",
     "ansys-api-speos==0.14.2",
+    "ansys-tools-path>=0.3.1",
     "numpy>=1.20.3,<3",
     "comtypes>=1.4,<1.5",
 ]
@@ -41,6 +42,7 @@ graphics = [
     "ansys-tools-visualization-interface>=0.8.3",
 ]
 tests = [
+    "psutil==6.1.1",
     "pytest==8.3.5",
     "pyvista>=0.40.0,<0.45",
     "ansys-tools-visualization-interface>=0.8.3",

src/ansys/speos/core/generic/constants.py

@@ -0,0 +1,36 @@
+# Copyright (C) 2021 - 2025 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.
+
+"""Collection of all constants used in pySpeos."""
+
+import os
+
+DEFAULT_HOST = "localhost"
+"""Default host used by Speos RPC server and client """
+DEFAULT_PORT = "50098"
+"""Default port used by Speos RPC server and client """
+LATEST_VERSION = "251"
+"""Latest supported Speos version of the current PySpeos Package"""
+MAX_MESSAGE_LENGTH = int(os.environ.get("SPEOS_MAX_MESSAGE_LENGTH", 256 * 1024**2))
+"""Maximum message length value accepted by the Speos RPC server,
+By default, value stored in environment variable SPEOS_MAX_MESSAGE_LENGTH or 268 435 456.
+"""

src/ansys/speos/core/generic/general_methods.py

@@ -26,8 +26,14 @@
 """
 
 from functools import wraps
+import os
+from pathlib import Path
+from typing import Optional, Union
 import warnings
 
+from ansys.speos.core.generic.constants import LATEST_VERSION
+from ansys.tools.path import get_available_ansys_installations
+
 __GRAPHICS_AVAILABLE = None
 GRAPHICS_ERROR = (
     "Preview unsupported without 'ansys-tools-visualization_interface' installed. "
@@ -108,3 +114,68 @@ def wrapper(*args, **kwargs):
         return method(*args, **kwargs)
 
     return wrapper
+
+
+def error_no_install(install_loc: Union[Path, str], version: Union[int, str]):
+    """Raise error that installation was not found at a location.
+
+    Parameters
+    ----------
+    install_loc : Union[Path, str]
+        Installation Path
+    version : Union[int, str]
+        Version
+    """
+    if not install_loc:
+        install_loc_msg = ""
+    else:
+        install_loc_msg = f"at {Path(install_loc).parent}"
+    raise FileNotFoundError(
+        f"Ansys Speos RPC server installation not found{install_loc_msg}. "
+        f"Please define AWP_ROOT{version} environment variable"
+    )
+
+
+def retrieve_speos_install_dir(
+    speos_rpc_loc: Optional[Union[Path, str]], version: str = LATEST_VERSION
+):
+    """Retrieve Speos install location based on Path or Environment.
+
+    Parameters
+    ----------
+    speos_rpc_loc : Optional[str, Path]
+        location of Speos rpc executable
+    version : str
+        The Speos server version to run, in the 3 digits format, such as "242".
+        If unspecified, the version will be chosen as
+        ``ansys.speos.core.kernel.client.LATEST_VERSION``.
+
+    """
+    if not speos_rpc_loc:
+        speos_rpc_loc = ""
+    if not speos_rpc_loc or not Path(speos_rpc_loc).exists():
+        if not Path(speos_rpc_loc).exists():
+            warnings.warn(
+                "Provided executable location not found, looking for local installation",
+                UserWarning,
+            )
+        versions = get_available_ansys_installations()
+        ansys_loc = versions.get(int(version), False)
+        if not ansys_loc:
+            ansys_loc = os.environ.get("AWP_ROOT{}".format(version), False)
+            if not ansys_loc:
+                error_no_install(speos_rpc_loc, int(version))
+
+        speos_rpc_loc = Path(ansys_loc) / "Optical Products" / "SPEOS_RPC"
+    elif Path(speos_rpc_loc).is_file():
+        if "SpeosRPC_Server" not in Path(speos_rpc_loc).name:
+            error_no_install(speos_rpc_loc, int(version))
+        else:
+            speos_rpc_loc = Path(speos_rpc_loc).parent
+    if os.name == "nt":
+        speos_exec = speos_rpc_loc / "SpeosRPC_Server.exe"
+    else:
+        speos_exec = speos_rpc_loc / "SpeosRPC_Server.x"
+    if not speos_exec.is_file():
+        error_no_install(speos_rpc_loc, int(version))
+    return speos_rpc_loc