ansys-mechanical-core 0.11.7__py3-none-any.whl → 0.11.8__py3-none-any.whl

ansys/mechanical/core/embedding/addins.py

@@ -52,9 +52,3 @@ class AddinConfiguration:
     @addin_configuration.setter
     def addin_configuration(self, value: str):
         self._addin_configuration = value
-
-
-def configure(configuration: AddinConfiguration):
-    """Apply the given configuration."""
-    if configuration.no_act_addins:
-        os.environ["ANSYS_MECHANICAL_STANDALONE_NO_ACT_EXTENSIONS"] = "1"

ansys/mechanical/core/embedding/app.py

@@ -31,6 +31,7 @@ from ansys.mechanical.core.embedding.addins import AddinConfiguration
 from ansys.mechanical.core.embedding.appdata import UniqueUserProfile
 from ansys.mechanical.core.embedding.imports import global_entry_points, global_variables
 from ansys.mechanical.core.embedding.poster import Poster
+from ansys.mechanical.core.embedding.ui import launch_ui
 from ansys.mechanical.core.embedding.warnings import connect_warnings, disconnect_warnings
 
 try:
@@ -191,6 +192,10 @@ class App:
         """Save the project as."""
         self.DataModel.Project.SaveAs(path)
 
+    def launch_gui(self, delete_tmp_on_close: bool = True, dry_run: bool = False):
+        """Launch the GUI."""
+        launch_ui(self, delete_tmp_on_close, dry_run)
+
     def new(self):
         """Clear to a new application."""
         self.DataModel.Project.New()
@@ -227,7 +232,21 @@ class App:
         light_mode = True
         args = None
         rets = None
-        return self.script_engine.ExecuteCode(script, SCRIPT_SCOPE, light_mode, args, rets)
+        script_result = self.script_engine.ExecuteCode(script, SCRIPT_SCOPE, light_mode, args, rets)
+        error_msg = f"Failed to execute the script"
+        if script_result is None:
+            raise Exception(error_msg)
+        if script_result.Error is not None:
+            error_msg += f": {script_result.Error.Message}"
+            raise Exception(error_msg)
+        return script_result.Value
+
+    def execute_script_from_file(self, file_path=None):
+        """Execute the given script from file with the internal IronPython engine."""
+        text_file = open(file_path, "r", encoding="utf-8")
+        data = text_file.read()
+        text_file.close()
+        return self.execute_script(data)
 
     def plotter(self) -> None:
         """Return ``ansys.tools.visualization_interface.Plotter`` object."""

ansys/mechanical/core/embedding/cleanup_gui.py

@@ -0,0 +1,61 @@
+# Copyright (C) 2022 - 2024 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.
+"""Clean up temporary mechdb files after GUI is closed."""
+
+from pathlib import Path
+import shutil
+import sys
+import time
+
+import psutil
+
+
+def cleanup_gui(pid, temp_mechdb) -> None:
+    """Remove the temporary mechdb file after it is closed.
+
+    Parameters
+    ----------
+    pid: int
+        The process ID of the open temporary mechdb file.
+    temp_mechdb: Path
+        The path of the temporary mechdb file.
+    """
+    # While the pid exists, sleep
+    while psutil.pid_exists(pid):
+        time.sleep(1)
+
+    # Delete the temporary mechdb file once the GUI is closed
+    temp_mechdb.unlink()
+
+    # Delete the temporary mechdb Mech_Files folder
+    temp_folder_path = temp_mechdb.parent / f"{temp_mechdb.name.split('.')[0]}_Mech_Files"
+    shutil.rmtree(temp_folder_path)
+
+
+if __name__ == "__main__":  # pragma: no cover
+    """Get the process ID and temporary file path to monitor and delete files after use."""
+    # Convert the process id (pid) argument into an integer
+    pid = int(sys.argv[1])
+    # Convert the temporary mechdb path into a Path
+    temp_mechdb_path = Path(sys.argv[2])
+    # Remove the temporary mechdb file when the GUI is closed
+    cleanup_gui(pid, temp_mechdb_path)

ansys/mechanical/core/embedding/initializer.py

@@ -28,15 +28,13 @@ import platform
 import sys
 import warnings
 
-import ansys.tools.path as atp
-
 from ansys.mechanical.core.embedding.loader import load_clr
 from ansys.mechanical.core.embedding.resolver import resolve
 
 INITIALIZED_VERSION = None
 """Constant for the initialized version."""
 
-SUPPORTED_MECHANICAL_EMBEDDING_VERSIONS_WINDOWS = {242: "2024R2", 241: "2024R1", 232: "2023R2"}
+SUPPORTED_MECHANICAL_EMBEDDING_VERSIONS = {242: "2024R2", 241: "2024R1", 232: "2023R2"}
 """Supported Mechanical embedding versions on Windows."""
 
 
@@ -59,48 +57,68 @@ def __workaround_material_server(version: int) -> None:
         os.environ["ENGRDATA_SERVER_SERIAL"] = "1"
 
 
-def _get_default_linux_version() -> int:
-    """Try to get the active linux version from the environment.
+def __check_for_supported_version(version) -> None:
+    """Check if Mechanical version is supported with current version of PyMechanical.
 
-    On linux, embedding is only possible by setting environment variables before starting python.
-    The version will then be fixed  to a specific version, based on those env vars.
-    The documented way to set those variables is to run python using the ``mechanical-env`` script,
-    which can be used after installing the ``ansys-mechanical-env`` package with this command:
-    ``pip install ansys-mechanical-env``. The script takes user input of a version. If the user
-    does not provide a version, the ``find_mechanical()`` function from the ``ansys-tools-path``
-    package is used to find a version of Mechanical.
+    If specific environment variable is enabled, then users can overwrite the supported versions.
+    However, using unsupported versions may cause issues.
     """
-    supported_versions = [232, 241, 242]
-    awp_roots = {ver: os.environ.get(f"AWP_ROOT{ver}", "") for ver in supported_versions}
-    installed_versions = {
-        ver: path for ver, path in awp_roots.items() if path and os.path.isdir(path)
-    }
-    assert len(installed_versions) == 1, "multiple AWP_ROOT environment variables found!"
-    return next(iter(installed_versions))
+    allow_old_version = os.getenv("ANSYS_MECHANICAL_EMBEDDING_SUPPORT_OLD_VERSIONS") == "1"
+
+    # Check if the version is supported
+    if not allow_old_version and version < min(SUPPORTED_MECHANICAL_EMBEDDING_VERSIONS):
+        raise ValueError(f"Mechanical version {version} is not supported.")
+
+    return version
 
 
-def _get_default_version() -> int:
-    if os.name == "posix":
-        return _get_default_linux_version()
+def _get_latest_default_version() -> int:
+    """Try to get the latest Mechanical version from the environment.
+
+    Checks if multiple versions of Mechanical found in system.
+    For Linux it will be only one since ``mechanical-env`` takes care of that.
+    If multiple versions are detected, select the latest one, as no specific version is provided.
+    """
+    awp_roots = [value for key, value in os.environ.items() if key.startswith("AWP_ROOT")]
+
+    if not awp_roots:
+        raise Exception("No Mechanical installations found.")
 
-    if os.name != "nt":  # pragma: no cover
-        raise Exception("Unexpected platform!")
+    versions_found = []
+    for path in awp_roots:
+        folder = os.path.basename(os.path.normpath(path))
+        version = folder.split("v")[-1]
+        versions_found.append(int(version))
+    latest_version = max(versions_found)
 
-    _, version = atp.find_mechanical(
-        supported_versions=SUPPORTED_MECHANICAL_EMBEDDING_VERSIONS_WINDOWS
-    )
+    if len(awp_roots) > 1:
+        warnings.warn(
+            f"Multiple versions of Mechanical found! Using latest version {latest_version} ..."
+        )
 
-    # version is of the form 23.2
-    int_version = int(str(version).replace(".", ""))
-    return int_version
+    return latest_version
 
 
-def __check_python_interpreter_architecture():
+def __check_python_interpreter_architecture() -> None:
     """Embedding support only 64 bit architecture."""
     if platform.architecture()[0] != "64bit":
         raise Exception("Mechanical Embedding requires a 64-bit Python environment.")
 
 
+def __set_environment(version: int) -> None:
+    """Set environment variables to configure embedding."""
+    if os.name == "nt":  # pragma: no cover
+        if version < 251:
+            os.environ["MECHANICAL_STARTUP_UNOPTIMIZED"] = "1"
+
+    # Set an environment variable to use the custom CLR host
+    # for embedding.
+    # In the future (>251), it would always be used.
+    if version == 251:
+        if "PYMECHANICAL_NO_CLR_HOST_LITE" not in os.environ:
+            os.environ["ANSYS_MECHANICAL_EMBEDDING_CLR_HOST"] = "1"
+
+
 def __check_for_mechanical_env():
     """Embedding in linux platform must use mechanical-env."""
     if platform.system() == "Linux" and os.environ.get("PYMECHANICAL_EMBEDDING") != "TRUE":
@@ -113,21 +131,60 @@ def __check_for_mechanical_env():
         )
 
 
+def __is_lib_loaded(libname: str):  # pragma: no cover
+    """Return whether a library is loaded."""
+    import ctypes
+
+    RTLD_NOLOAD = 4
+    try:
+        ctypes.CDLL(libname, RTLD_NOLOAD)
+    except:
+        return False
+    return True
+
+
+def __check_loaded_libs(version: int = None):  # pragma: no cover
+    """Ensure that incompatible libraries aren't loaded prior to PyMechanical load."""
+    if platform.system() != "Linux":
+        return
+
+    if version < 251:
+        return
+
+    # For 2025 R1, PyMechanical will crash on shutdown if libX11.so is already loaded
+    # before starting Mechanical
+    if __is_lib_loaded("libX11.so"):
+        warnings.warn(
+            "libX11.so is loaded prior to initializing the Embedded Instance of Mechanical.\
+                      Python will crash on shutdown..."
+        )
+
+
 def initialize(version: int = None):
     """Initialize Mechanical embedding."""
     __check_python_interpreter_architecture()  # blocks 32 bit python
     __check_for_mechanical_env()  # checks for mechanical-env in linux embedding
 
     global INITIALIZED_VERSION
-    if INITIALIZED_VERSION != None:
-        assert INITIALIZED_VERSION == version
+    if INITIALIZED_VERSION is not None:
+        if INITIALIZED_VERSION != version:
+            raise ValueError(
+                f"Initialized version {INITIALIZED_VERSION} "
+                f"does not match the expected version {version}."
+            )
         return
 
     if version == None:
-        version = _get_default_version()
+        version = _get_latest_default_version()
+
+    version = __check_for_supported_version(version=version)
 
     INITIALIZED_VERSION = version
 
+    __set_environment(version)
+
+    __check_loaded_libs(version)
+
     __workaround_material_server(version)
 
     # need to add system path in order to import the assembly with the resolver

ansys/mechanical/core/embedding/ui.py

@@ -0,0 +1,225 @@
+# Copyright (C) 2022 - 2024 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.
+"""Run Mechanical UI from Python."""
+
+from pathlib import Path
+from subprocess import Popen
+import sys
+import tempfile
+import typing
+
+
+class UILauncher:
+    """Launch the GUI using a temporary mechdb file."""
+
+    def __init__(self, dry_run: bool = False):
+        """Initialize UILauncher class."""
+        self._dry_run = dry_run
+
+    def save_original(self, app: "ansys.mechanical.core.embedding.App") -> None:
+        """Save the active mechdb file.
+
+        Parameters
+        ----------
+        app: ansys.mechanical.core.embedding.app.App
+            A Mechanical embedding application.
+        """
+        app.save()
+
+    def save_temp_copy(
+        self, app: "ansys.mechanical.core.embedding.App"
+    ) -> typing.Union[Path, Path]:
+        """Save a new mechdb file with a temporary name.
+
+        Parameters
+        ----------
+        app: ansys.mechanical.core.embedding.app.App
+            A Mechanical embedding application.
+        """
+        # Identify the mechdb of the saved session from save_original()
+        project_directory = Path(app.DataModel.Project.ProjectDirectory)
+        project_directory_parent = project_directory.parent
+        mechdb_file = (
+            project_directory_parent / f"{project_directory.parts[-1].split('_')[0]}.mechdb"
+        )
+
+        # Get name of NamedTemporaryFile
+        temp_file_name = tempfile.NamedTemporaryFile(
+            dir=project_directory_parent, suffix=".mechdb", delete=True
+        ).name
+
+        # Save app with name of temporary file
+        app.save_as(temp_file_name)
+
+        return mechdb_file, temp_file_name
+
+    def open_original(self, app: "ansys.mechanical.core.embedding.App", mechdb_file: str) -> None:
+        """Open the original mechdb file from save_original().
+
+        Parameters
+        ----------
+        app: ansys.mechanical.core.embedding.app.App
+            A Mechanical embedding application.
+        mechdb_file: str
+            The full path to the active mechdb file.
+        """
+        app.open(mechdb_file)
+
+    def graphically_launch_temp(
+        self, app: "ansys.mechanical.core.embedding.App", temp_file: Path
+    ) -> typing.Union[Popen, str]:
+        """Launch the GUI for the mechdb file with a temporary name from save_temp_copy().
+
+        Parameters
+        ----------
+        app: ansys.mechanical.core.embedding.app.App
+            A Mechanical embedding application.
+        temp_file: pathlib.Path
+            The full path to the temporary mechdb file.
+
+        Returns
+        -------
+        subprocess.Popen
+            The subprocess that launches the GUI for the temporary mechdb file.
+        """
+        # The ansys-mechanical command to launch the GUI in a subprocess
+        args = [
+            "ansys-mechanical",
+            "--project-file",
+            temp_file,
+            "--graphical",
+            "--revision",
+            str(app.version),
+        ]
+        if not self._dry_run:
+            # The subprocess that uses ansys-mechanical to launch the GUI of the temporary
+            # mechdb file
+            process = Popen(args)
+            return process
+        else:
+            # Return a string containing the args
+            return " ".join(args)
+
+    def _cleanup_gui(self, process: Popen, temp_mechdb_path: Path) -> None:
+        """Remove the temporary mechdb file and folder when the GUI is closed.
+
+        Parameters
+        ----------
+        process: subprocess.Popen
+            The subprocess that launched the GUI of the temporary mechdb file.
+        temp_mechdb_path: pathlib.Path
+            The full path to the temporary mechdb file.
+        """
+        # Get the path to the cleanup script
+        cleanup_script = Path(__file__).parent / "cleanup_gui.py"  # pragma: no cover
+
+        if not self._dry_run:
+            # Open a subprocess to remove the temporary mechdb file and folder when the process ends
+            Popen(
+                [sys.executable, cleanup_script, str(process.pid), temp_mechdb_path]
+            )  # pragma: no cover
+
+
+def _is_saved(app: "ansys.mechanical.core.embedding.App") -> bool:
+    """Check if the mechdb file has been saved and raise an exception if not.
+
+    Parameters
+    ----------
+    app: ansys.mechanical.core.embedding.app.App
+        A Mechanical embedding application.
+
+    Returns
+    -------
+    bool
+        ``True`` when the embedded app has been saved.
+        ``False`` when the embedded app has not been saved.
+    """
+    try:
+        app.save()
+    except:
+        raise Exception("The App must have already been saved before using launch_ui!")
+    return True
+
+
+def _launch_ui(
+    app: "ansys.mechanical.core.embedding.App", delete_tmp_on_close: bool, launcher: UILauncher
+) -> None:
+    """Launch the Mechanical UI if the mechdb file has been saved.
+
+    Parameters
+    ----------
+    app: ansys.mechanical.core.embedding.app.App
+        A Mechanical embedding application.
+    delete_tmp_on_close: bool
+        Whether to delete the temporary mechdb file when the GUI is closed.
+        By default, this is ``True``.
+    launcher: UILauncher
+        Launch the GUI using a temporary mechdb file.
+    """
+    if _is_saved(app):
+        # Save the active mechdb file.
+        launcher.save_original(app)
+        # Save a new mechdb file with a temporary name.
+        mechdb_file, temp_file = launcher.save_temp_copy(app)
+        # Open the original mechdb file from save_original().
+        launcher.open_original(app, str(mechdb_file))
+        # Launch the GUI for the mechdb file with a temporary name from save_temp_copy().
+        process = launcher.graphically_launch_temp(app, temp_file)
+
+        # If it's a dry run and graphically_launch_temp returned a string, print the string
+        if isinstance(process, str):
+            print(process)
+
+        # If the user wants the temporary file to be deleted and graphically_launch_temp
+        # returned a process. By default, this is True
+        if delete_tmp_on_close and not isinstance(process, str):
+            # Remove the temporary mechdb file and folder when the GUI is closed.
+            launcher._cleanup_gui(process, temp_file)  # pragma: no cover
+        else:
+            # Let the user know that the mechdb started above will not automatically get cleaned up
+            print(
+                f"""Opened a new mechanical session based on {mechdb_file} named {temp_file}.
+PyMechanical will not delete it after use."""
+            )
+
+
+def launch_ui(
+    app: "ansys.mechanical.core.embedding.App",
+    delete_tmp_on_close: bool = True,
+    dry_run: bool = False,
+) -> None:
+    """Launch the Mechanical UI.
+
+    Precondition: Mechanical has to have already been saved
+    Side effect: If Mechanical has ever been saved, it overwrites that save.
+
+    Parameters
+    ----------
+    app: ansys.mechanical.core.embedding.app.App
+        A Mechanical embedding application.
+    delete_tmp_on_close: bool
+        Whether to delete the temporary mechdb file when the GUI is closed.
+        By default, this is ``True``.
+    dry_run: bool
+        Whether or not to launch the GUI. By default, this is ``False``.
+    """
+    _launch_ui(app, delete_tmp_on_close, UILauncher(dry_run))

ansys/mechanical/core/embedding/viz/utils.py

@@ -41,7 +41,8 @@ def _reshape_3cols(arr: np.array, name: str = "array"):
     """
     err = f"{name} must be of the form (x0,y0,z0,x1,y1,z1,...,xn,yn,zn).\
         Given {name} are not divisible by 3!"
-    assert arr.size % 3 == 0, err
+    if arr.size % 3 != 0:
+        raise ValueError(err)
     numrows = int(arr.size / 3)
     numcols = 3
     arr = np.reshape(arr, (numrows, numcols))

ansys/mechanical/core/ide_config.py

@@ -0,0 +1,164 @@
+# Copyright (C) 2022 - 2024 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.
+
+"""Convenience CLI to run mechanical."""
+
+import json
+import os
+from pathlib import Path
+import sys
+import sysconfig
+
+import ansys.tools.path as atp
+import click
+
+
+def _vscode_impl(
+    target: str = "user",
+    revision: int = None,
+):
+    """Get the IDE configuration for autocomplete in VS Code.
+
+    Parameters
+    ----------
+    target: str
+        The type of settings to update. Either "user" or "workspace" in VS Code.
+        By default, it's ``user``.
+    revision: int
+        The Mechanical revision number. For example, "242".
+        If unspecified, it finds the default Mechanical version from ansys-tools-path.
+    """
+    # Update the user or workspace settings
+    if target == "user":
+        # Get the path to the user's settings.json file depending on the platform
+        if "win" in sys.platform:
+            settings_json = (
+                Path(os.environ.get("APPDATA")) / "Code" / "User" / "settings.json"
+            )  # pragma: no cover
+        elif "lin" in sys.platform:
+            settings_json = (
+                Path(os.environ.get("HOME")) / ".config" / "Code" / "User" / "settings.json"
+            )
+    elif target == "workspace":
+        # Get the current working directory
+        current_dir = Path.cwd()
+        # Get the path to the settings.json file based on the git root & .vscode folder
+        settings_json = current_dir / ".vscode" / "settings.json"
+
+    # Location where the stubs are installed -> .venv/Lib/site-packages, for example
+    stubs_location = (
+        Path(sysconfig.get_paths()["purelib"]) / "ansys" / "mechanical" / "stubs" / f"v{revision}"
+    )
+
+    # The settings to add to settings.json for autocomplete to work
+    settings_json_data = {
+        "python.autoComplete.extraPaths": [str(stubs_location)],
+        "python.analysis.extraPaths": [str(stubs_location)],
+    }
+    # Pretty print dictionary
+    pretty_dict = json.dumps(settings_json_data, indent=4)
+
+    print(f"Update {settings_json} with the following information:\n")
+
+    if target == "workspace":
+        print(
+            "Note: Please ensure the .vscode folder is in the root of your project or repository.\n"
+        )
+
+    print(pretty_dict)
+
+
+def _cli_impl(
+    ide: str = "vscode",
+    target: str = "user",
+    revision: int = None,
+):
+    """Provide the user with the path to the settings.json file and IDE settings.
+
+    Parameters
+    ----------
+    ide: str
+        The IDE to set up autocomplete settings. By default, it's ``vscode``.
+    target: str
+        The type of settings to update. Either "user" or "workspace" in VS Code.
+        By default, it's ``user``.
+    revision: int
+        The Mechanical revision number. For example, "242".
+        If unspecified, it finds the default Mechanical version from ansys-tools-path.
+    """
+    # Check the IDE and raise an exception if it's not VS Code
+    if ide == "vscode":
+        return _vscode_impl(target, revision)
+    else:
+        raise Exception(f"{ide} is not supported at the moment.")
+
+
+@click.command()
+@click.help_option("--help", "-h")
+@click.option(
+    "--ide",
+    default="vscode",
+    type=str,
+    help="The IDE being used.",
+)
+@click.option(
+    "--target",
+    default="user",
+    type=str,
+    help="The type of settings to update - either ``user`` or ``workspace`` settings.",
+)
+@click.option(
+    "--revision",
+    default=None,
+    type=int,
+    help='The Mechanical revision number, e.g. "242" or "241". If unspecified,\
+it finds and uses the default version from ansys-tools-path.',
+)
+def cli(ide: str, target: str, revision: int) -> None:
+    """CLI tool to update settings.json files for autocomplete with ansys-mechanical-stubs.
+
+    Parameters
+    ----------
+    ide: str
+        The IDE to set up autocomplete settings. By default, it's ``vscode``.
+    target: str
+        The type of settings to update. Either "user" or "workspace" in VS Code.
+        By default, it's ``user``.
+    revision: int
+        The Mechanical revision number. For example, "242".
+        If unspecified, it finds the default Mechanical version from ansys-tools-path.
+
+    Usage
+    -----
+    The following example demonstrates the main use of this tool:
+
+        $ ansys-mechanical-ideconfig --ide vscode --location user --revision 242
+
+    """
+    exe = atp.get_mechanical_path(allow_input=False, version=revision)
+    version = atp.version_from_path("mechanical", exe)
+
+    return _cli_impl(
+        ide,
+        target,
+        version,
+    )

ansys/mechanical/core/mechanical.py

@@ -508,8 +508,8 @@ class Mechanical(object):
                     return f"GRPC_{self._channel._channel._channel.target().decode()}"
                 else:
                     return f"GRPC_{self._channel._channel.target().decode()}"
-        except Exception:  # pragma: no cover
-            pass
+        except Exception as e:  # pragma: no cover
+            LOG.error(f"Error getting the Mechanical instance name: {str(e)}")
 
         return f"GRPC_instance_{id(self)}"  # pragma: no cover
 

ansys/mechanical/core/pool.py

@@ -583,8 +583,8 @@ class LocalMechanicalPool:
             if instance_local:
                 try:
                     instance_local.exit()
-                except:  # pragma: no cover
-                    pass
+                except Exception as e:  # pragma: no cover
+                    LOG.error(f"Error while exiting instance {str(instance_local)}: {str(e)}")
                 self._instances[index] = None
                 LOG.debug(f"Exited instance: {str(instance_local)}")
 

ansys/mechanical/core/run.py

@@ -54,7 +54,8 @@ async def _read_and_display(cmd, env, do_display: bool):
     }
     while tasks:
         done, pending = await asyncio.wait(tasks, return_when=asyncio.FIRST_COMPLETED)
-        assert done
+        if not done:
+            raise RuntimeError("Subprocess read failed: No tasks completed.")
         for future in done:
             buf, stream, display = tasks.pop(future)
             line = future.result()
@@ -67,7 +68,7 @@ async def _read_and_display(cmd, env, do_display: bool):
 
     # wait for the process to exit
     rc = await process.wait()
-    return rc, b"".join(stdout), b"".join(stderr)
+    return rc, process, b"".join(stdout), b"".join(stderr)
 
 
 def _run(args, env, check=False, display=False):
@@ -77,13 +78,13 @@ def _run(args, env, check=False, display=False):
     else:
         loop = asyncio.get_event_loop()
     try:
-        rc, *output = loop.run_until_complete(_read_and_display(args, env, display))
+        rc, process, *output = loop.run_until_complete(_read_and_display(args, env, display))
         if rc and check:
             sys.exit("child failed with '{}' exit code".format(rc))
     finally:
         if os.name == "nt":
             loop.close()
-    return output
+    return process, output
 
 
 def _cli_impl(

{ansys_mechanical_core-0.11.7.dist-info → ansys_mechanical_core-0.11.8.dist-info}/METADATA

@@ -1,23 +1,22 @@
 Metadata-Version: 2.1
 Name: ansys-mechanical-core
-Version: 0.11.7
+Version: 0.11.8
 Summary: A python wrapper for Ansys Mechanical
 Keywords: pymechanical,mechanical,ansys,pyansys
 Author-email: "ANSYS, Inc." <pyansys.core@ansys.com>
 Maintainer-email: "ANSYS, Inc." <pyansys.core@ansys.com>
-Requires-Python: >=3.9,<4.0
+Requires-Python: >=3.10,<4.0
 Description-Content-Type: text/x-rst
 Classifier: Development Status :: 4 - Beta
 Classifier: Intended Audience :: Science/Research
 Classifier: Topic :: Scientific/Engineering :: Information Analysis
-Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Operating System :: OS Independent
 Requires-Dist: ansys-api-mechanical==0.1.2
-Requires-Dist: ansys-mechanical-env==0.1.7
+Requires-Dist: ansys-mechanical-env==0.1.8
 Requires-Dist: ansys-platform-instancemanagement>=1.0.1
 Requires-Dist: ansys-pythonnet>=3.1.0rc2
 Requires-Dist: ansys-tools-path>=0.3.1
@@ -26,35 +25,37 @@ Requires-Dist: click>=8.1.3
 Requires-Dist: clr-loader==0.2.6
 Requires-Dist: grpcio>=1.30.0
 Requires-Dist: protobuf>=3.12.2,<6
+Requires-Dist: psutil==6.0.0
 Requires-Dist: tqdm>=4.45.0
-Requires-Dist: sphinx==8.0.2 ; extra == "doc"
-Requires-Dist: ansys-sphinx-theme[autoapi]==1.0.7 ; extra == "doc"
-Requires-Dist: grpcio==1.66.0 ; extra == "doc"
+Requires-Dist: sphinx==8.1.3 ; extra == "doc"
+Requires-Dist: ansys-sphinx-theme[autoapi]==1.1.4 ; extra == "doc"
+Requires-Dist: grpcio==1.66.2 ; extra == "doc"
 Requires-Dist: imageio-ffmpeg==0.5.1 ; extra == "doc"
-Requires-Dist: imageio==2.35.1 ; extra == "doc"
+Requires-Dist: imageio==2.36.0 ; extra == "doc"
 Requires-Dist: jupyter_sphinx==0.5.3 ; extra == "doc"
 Requires-Dist: jupyterlab>=3.2.8 ; extra == "doc"
 Requires-Dist: matplotlib==3.9.2 ; extra == "doc"
-Requires-Dist: numpy==2.1.0 ; extra == "doc"
+Requires-Dist: numpy==2.1.2 ; extra == "doc"
 Requires-Dist: numpydoc==1.8.0 ; extra == "doc"
-Requires-Dist: pandas==2.2.2 ; extra == "doc"
-Requires-Dist: panel==1.4.5 ; extra == "doc"
-Requires-Dist: plotly==5.23.0 ; extra == "doc"
-Requires-Dist: pypandoc==1.13 ; extra == "doc"
+Requires-Dist: pandas==2.2.3 ; extra == "doc"
+Requires-Dist: panel==1.5.2 ; extra == "doc"
+Requires-Dist: plotly==5.24.1 ; extra == "doc"
+Requires-Dist: pypandoc==1.14 ; extra == "doc"
 Requires-Dist: pytest-sphinx==0.6.3 ; extra == "doc"
 Requires-Dist: pythreejs==2.4.2 ; extra == "doc"
 Requires-Dist: pyvista>=0.39.1 ; extra == "doc"
-Requires-Dist: sphinx-autobuild==2024.4.16 ; extra == "doc"
-Requires-Dist: sphinx-autodoc-typehints==2.2.3 ; extra == "doc"
+Requires-Dist: sphinx-autobuild==2024.10.3 ; extra == "doc"
+Requires-Dist: sphinx-autodoc-typehints==2.5.0 ; extra == "doc"
 Requires-Dist: sphinx-copybutton==0.5.2 ; extra == "doc"
 Requires-Dist: sphinx_design==0.6.1 ; extra == "doc"
-Requires-Dist: sphinx-gallery==0.17.1 ; extra == "doc"
+Requires-Dist: sphinx-gallery==0.18.0 ; extra == "doc"
 Requires-Dist: sphinx-notfound-page==1.0.4 ; extra == "doc"
 Requires-Dist: sphinxcontrib-websupport==2.0.0 ; extra == "doc"
 Requires-Dist: sphinxemoji==0.3.1 ; extra == "doc"
-Requires-Dist: pytest==8.3.2 ; extra == "tests"
+Requires-Dist: pytest==8.3.3 ; extra == "tests"
 Requires-Dist: pytest-cov==5.0.0 ; extra == "tests"
-Requires-Dist: pytest-print==1.0.0 ; extra == "tests"
+Requires-Dist: pytest-print==1.0.2 ; extra == "tests"
+Requires-Dist: psutil==6.0.0 ; extra == "tests"
 Requires-Dist: ansys-tools-visualization-interface>=0.2.6 ; extra == "viz"
 Requires-Dist: usd-core==24.8 ; extra == "viz"
 Project-URL: Changelog, https://mechanical.docs.pyansys.com/version/stable/changelog.html

{ansys_mechanical_core-0.11.7.dist-info → ansys_mechanical_core-0.11.8.dist-info}/RECORD

@@ -2,26 +2,29 @@ ansys/mechanical/core/__init__.py,sha256=91oPPatmqRyry_kzusIq522MQNiBgN5Of54zDMI
 ansys/mechanical/core/_version.py,sha256=V2aPQlSX4bCe1N1hLIkQaed84WN4s9wl6Q7890ZihNU,1744
 ansys/mechanical/core/errors.py,sha256=oGaBH-QZxen3YV3IChAFv8bwW5rK_IXTYgDqbX5lp1E,4508
 ansys/mechanical/core/feature_flags.py,sha256=L88vHrI2lRjZPPUTW5sqcdloeK3Ouh8vt1VPfZLs5Wc,2032
+ansys/mechanical/core/ide_config.py,sha256=44xst5N67ekVq8GhFMhetJDLJOTJcPJfu1mSaZdxNzI,5619
 ansys/mechanical/core/launcher.py,sha256=-I1hoscyc5HY8EHL07gPUeoeRgUJaW8agdQWOpqK30A,6659
 ansys/mechanical/core/logging.py,sha256=wQ8QwKd2k0R6SkN7cv2nHAO7V5-BrElEOespDNMpSLo,24554
-ansys/mechanical/core/mechanical.py,sha256=rh8vClBiUZRxEsI3asYbvIznGrwNZiUM64MRt8mSpPU,79926
+ansys/mechanical/core/mechanical.py,sha256=MOGEMYgT9Mz0GFnTbixw-5SlfDEfZ-f4iDJG8mtXAVE,79993
 ansys/mechanical/core/misc.py,sha256=edm2UnklbooYW_hQUgk4n_UFCtlSGAVYJmC2gag74vw,5370
-ansys/mechanical/core/pool.py,sha256=HzU64Ew5QgoKeoZkywdmS_lmuGSCwe-PvucI5y1Hqa0,26429
-ansys/mechanical/core/run.py,sha256=ScB-Ne8KkLuA0EQtquUa8JKFsA8Ert8nUUtxHTlQR4A,9814
+ansys/mechanical/core/pool.py,sha256=jC3quT7fsGMkfrPJ-nZhiigYmzXlj80L9fH9emE7Rrw,26514
+ansys/mechanical/core/run.py,sha256=KgSL2XEyCxK7iq_XVDNEv6fx7SN56RA-ihNg2dLyuZc,9920
 ansys/mechanical/core/embedding/__init__.py,sha256=y0yp3dnBW2oj9Jh_L_qfZstAbpON974EMmpV9w3kT3g,1356
-ansys/mechanical/core/embedding/addins.py,sha256=yRG8CT1f1MgQj0y_mP3ISePVp7t9erw0o5Sbn1tFNkc,2370
-ansys/mechanical/core/embedding/app.py,sha256=hnP-eAFFekfHPuHxHc7wJraDa1DO7s2J65dWtKzRJ9U,16195
+ansys/mechanical/core/embedding/addins.py,sha256=2-de-sIOWjO5MCKdBHC2LFxTItr1DUztABIONTQhiWc,2167
+ansys/mechanical/core/embedding/app.py,sha256=Bc3OlcZHzLDcmmfiDiwXRY_SJ6nSU3eIowm2Db3Xg_Y,17033
 ansys/mechanical/core/embedding/app_libraries.py,sha256=RiTO23AzjssAylIH2DaTa6mcJmxhfrlHW-yYvHpIkt0,2923
 ansys/mechanical/core/embedding/appdata.py,sha256=krcmcgHhraHIlORFr43QvUXlAiXg231g_2iOIxkW_aQ,4223
 ansys/mechanical/core/embedding/background.py,sha256=ICm87gO6CDA4Ot_6Yf3-8YPNUEa3PHWieOECXeUfZmM,3650
+ansys/mechanical/core/embedding/cleanup_gui.py,sha256=GvWX2ylGBb5k1Hgz9vUywXNgWpDVwZ6L2M4gaOXyxl4,2354
 ansys/mechanical/core/embedding/enum_importer.py,sha256=3REw7SI_WmfPuzD0i9mdC7k53S-1jxhowqSxjzw7UGk,1543
 ansys/mechanical/core/embedding/imports.py,sha256=FcpePAi867YCuCH_lJotrLzYc1MW5VSAaLpYz7RejcA,4287
-ansys/mechanical/core/embedding/initializer.py,sha256=-LNJqDlxemHCggM5Ud5X7KDVpW4USoxc0djKcVAsdW0,6366
+ansys/mechanical/core/embedding/initializer.py,sha256=I09XzY7QFhCvaHlrLDrx9U-8Bib9vS9yvFQnWOscSzw,8025
 ansys/mechanical/core/embedding/loader.py,sha256=UgWN7C4hGMWiHhoMUdRKRyWaOwcsgw5auoW1ZqLtZDs,2503
 ansys/mechanical/core/embedding/poster.py,sha256=V0-cm229HgpOgcYXa0bnz0U5BDGw8_AVE6LKXyPCEjo,2107
 ansys/mechanical/core/embedding/resolver.py,sha256=95jUvZhNFEJBlbAbclzpK1Wgk51KsnYOKa5HvC7Oeco,1878
 ansys/mechanical/core/embedding/runtime.py,sha256=zDxwKDTc23cR_kc63M9u4zDWVoJ2efEtF3djHGwicG4,2285
 ansys/mechanical/core/embedding/shims.py,sha256=IJHhUmfsCtYEUFmuf2LGgozTiu03D0OZn1Qq1nCxXiI,1732
+ansys/mechanical/core/embedding/ui.py,sha256=4XCl9ay30D1sOzLyHFwG_bK7IboYBWNiCrbTM3cYhnc,8331
 ansys/mechanical/core/embedding/utils.py,sha256=UObL4XBvx19aAYV8iVM4eCQR9vfqNSDsdwqkb1VFwTY,1900
 ansys/mechanical/core/embedding/warnings.py,sha256=igXfTCkDb8IDQqYP02Cynsqr7ewnueR12Dr0zpku7Kw,3071
 ansys/mechanical/core/embedding/logger/__init__.py,sha256=XgC05i7r-YzotLtcZ5_rGtA0jDKzeuZiDB88d2pIL7o,7986
@@ -32,11 +35,11 @@ ansys/mechanical/core/embedding/logger/windows_api.py,sha256=OCJ-SJEY7EjigZiW6H5
 ansys/mechanical/core/embedding/viz/__init__.py,sha256=xgpBdf3yfEq3sn0bNewLwtje-SCH6vVWEmHfCdh6078,1206
 ansys/mechanical/core/embedding/viz/embedding_plotter.py,sha256=ausbFhezwmLCGhu61JZJDM_uxwpRRuM-XWw9mk4i0GQ,3689
 ansys/mechanical/core/embedding/viz/usd_converter.py,sha256=feDq2KrZhYL-RR1miECQL-y0VNDhnZQ9Wke5UOkYmp4,5329
-ansys/mechanical/core/embedding/viz/utils.py,sha256=NWc18HLshIpO7wgZpwfduKG5wReaYtVtJPChOosKXLU,3638
+ansys/mechanical/core/embedding/viz/utils.py,sha256=FuGDh7a5mUqs2UZOaXZLD0vONdmDXl5JfDRilIVbjds,3660
 ansys/mechanical/core/examples/__init__.py,sha256=A1iS8nknTU1ylafHZpYC9LQJ0sY83x8m1cDXsgvFOBo,1267
 ansys/mechanical/core/examples/downloads.py,sha256=lJ2SrX9Qs0t2FSmMwUBB4UgSpk6Qb2-coY1PLlzPzHU,4144
-ansys_mechanical_core-0.11.7.dist-info/entry_points.txt,sha256=wRXPv0eRXSmodweJHjF_Y3x5wmeSmjWcY3Bo6B4tAiM,66
-ansys_mechanical_core-0.11.7.dist-info/LICENSE,sha256=gBJ2GQ6oDJwAWxcxmjx_0uXc-N0P4sHhA7BXsdPTfco,1098
-ansys_mechanical_core-0.11.7.dist-info/WHEEL,sha256=EZbGkh7Ie4PoZfRQ8I0ZuP9VklN_TvcZ6DSE5Uar4z4,81
-ansys_mechanical_core-0.11.7.dist-info/METADATA,sha256=C9roYcJNV8NVEN4br1yps8J_0PR3W_373Y1xolXlFjM,9783
-ansys_mechanical_core-0.11.7.dist-info/RECORD,,
+ansys_mechanical_core-0.11.8.dist-info/entry_points.txt,sha256=tErx6bIM27HGgwyM6ryyTUTw30Ab2F9J3FFkX2TPkhI,130
+ansys_mechanical_core-0.11.8.dist-info/LICENSE,sha256=gBJ2GQ6oDJwAWxcxmjx_0uXc-N0P4sHhA7BXsdPTfco,1098
+ansys_mechanical_core-0.11.8.dist-info/WHEEL,sha256=EZbGkh7Ie4PoZfRQ8I0ZuP9VklN_TvcZ6DSE5Uar4z4,81
+ansys_mechanical_core-0.11.8.dist-info/METADATA,sha256=WpLgvz8EIi3vt36XykzYWPtLSs8-Aj4etwPrqg4nJ8Q,9811
+ansys_mechanical_core-0.11.8.dist-info/RECORD,,

{ansys_mechanical_core-0.11.7.dist-info → ansys_mechanical_core-0.11.8.dist-info}/entry_points.txt

@@ -1,3 +1,4 @@
 [console_scripts]
 ansys-mechanical=ansys.mechanical.core.run:cli
+ansys-mechanical-ideconfig=ansys.mechanical.core.ide_config:cli