feat: refactoring launcher module

doc/changelog.d/3649.miscellaneous.md

@@ -0,0 +1 @@
+feat: refactoring launcher module

src/ansys/mapdl/core/__init__.py

@@ -110,7 +110,9 @@
 
 # override default launcher when on pyansys.com
 if "ANSJUPHUB_VER" in os.environ:  # pragma: no cover
-    from ansys.mapdl.core.jupyter import launch_mapdl_on_cluster as launch_mapdl
+    from ansys.mapdl.core.launcher.jupyter import (
+        launch_mapdl_on_cluster as launch_mapdl,
+    )
 else:
     from ansys.mapdl.core.launcher import launch_mapdl
 

src/ansys/mapdl/core/cli/stop.py

@@ -172,7 +172,7 @@ def _kill_process(proc):
 def _is_valid_ansys_process(PROCESS_OK_STATUS, proc):
     import psutil
 
-    from ansys.mapdl.core.launcher import is_ansys_process
+    from ansys.mapdl.core.launcher.tools import is_ansys_process
 
     return (
         psutil.pid_exists(proc.pid)

src/ansys/mapdl/core/launcher/__init__.py

@@ -0,0 +1,68 @@
+# Copyright (C) 2016 - 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.
+
+import os
+import warnings
+
+from ansys.mapdl.core import _HAS_ATP, LOG
+
+LOCALHOST = "127.0.0.1"
+MAPDL_DEFAULT_PORT = 50052
+
+ON_WSL = os.name == "posix" and (
+    os.environ.get("WSL_DISTRO_NAME") or os.environ.get("WSL_INTEROP")
+)
+
+if ON_WSL:
+    LOG.info("On WSL: Running on WSL detected.")
+    LOG.debug("On WSL: Allowing 'start_instance' and 'ip' arguments together.")
+
+
+from ansys.mapdl.core.launcher.console import launch_mapdl_console
+from ansys.mapdl.core.launcher.grpc import launch_mapdl_grpc
+from ansys.mapdl.core.launcher.hpc import launch_mapdl_on_cluster_locally
+from ansys.mapdl.core.launcher.launcher import launch_mapdl
+from ansys.mapdl.core.launcher.remote import connect_to_mapdl
+from ansys.mapdl.core.launcher.tools import (
+    close_all_local_instances,
+    get_default_ansys,
+    get_default_ansys_path,
+    get_default_ansys_version,
+)
+
+if _HAS_ATP:
+    from functools import wraps
+
+    from ansys.tools.path import find_mapdl, get_mapdl_path
+    from ansys.tools.path import version_from_path as _version_from_path
+
+    @wraps(_version_from_path)
+    def version_from_path(*args, **kwargs):
+        """Wrap ansys.tool.path.version_from_path to raise a warning if the
+        executable couldn't be found"""
+        if kwargs.pop("launch_on_hpc", False):
+            try:
+                return _version_from_path(*args, **kwargs)
+            except RuntimeError:
+                warnings.warn("PyMAPDL could not find the ANSYS executable. ")
+        else:
+            return _version_from_path(*args, **kwargs)

src/ansys/mapdl/core/launcher/console.py

@@ -0,0 +1,107 @@
+# Copyright (C) 2016 - 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.
+
+from typing import Optional, Union
+
+from ansys.mapdl.core import LOG
+from ansys.mapdl.core.launcher.local import processing_local_arguments
+from ansys.mapdl.core.launcher.tools import generate_start_parameters
+from ansys.mapdl.core.licensing import LicenseChecker
+from ansys.mapdl.core.mapdl_console import MapdlConsole
+
+
+def check_console_start_parameters(start_parm):
+    valid_args = [
+        "exec_file",
+        "run_location",
+        "jobname",
+        "nproc",
+        "additional_switches",
+        "start_timeout",
+    ]
+    for each in list(start_parm.keys()):
+        if each not in valid_args:
+            start_parm.pop(each)
+
+    return start_parm
+
+
+def launch_mapdl_console(
+    exec_file: Optional[str] = None,
+    run_location: Optional[str] = None,
+    jobname: str = "file",
+    *,
+    nproc: Optional[int] = None,
+    ram: Optional[Union[int, str]] = None,
+    override: bool = False,
+    loglevel: str = "ERROR",
+    additional_switches: str = "",
+    start_timeout: Optional[int] = None,
+    log_apdl: Optional[Union[bool, str]] = None,
+):
+    ########################################
+    # Processing arguments
+    # --------------------
+    #
+    # processing arguments
+    args = processing_local_arguments(locals())
+
+    # Check for a valid connection mode
+    if args.get("mode", "console") != "console":
+        raise ValueError("Invalid 'mode'.")
+
+    start_parm = generate_start_parameters(args)
+
+    # Early exit for debugging.
+    if args["_debug_no_launch"]:
+        # Early exit, just for testing
+        return args  # type: ignore
+
+    ########################################
+    # Local launching
+    # ---------------
+    #
+    # Check the license server
+    if args["license_server_check"]:
+        LOG.debug("Checking license server.")
+        lic_check = LicenseChecker(timeout=args["start_timeout"])
+        lic_check.start()
+
+    LOG.debug("Starting MAPDL")
+    ########################################
+    # Launch MAPDL on console mode
+    # ----------------------------
+    #
+    start_parm = check_console_start_parameters(start_parm)
+    mapdl = MapdlConsole(
+        loglevel=args["loglevel"],
+        log_apdl=args["log_apdl"],
+        use_vtk=args["use_vtk"],
+        **start_parm,
+    )
+
+    # Stop license checker
+    if args["license_server_check"]:
+        LOG.debug("Stopping check on license server.")
+        lic_check.stop()
+
+    return mapdl