ansys-mechanical-core 0.11.13__py3-none-any.whl → 0.11.15__py3-none-any.whl

ansys/mechanical/core/__init__.py

@@ -44,10 +44,12 @@ from ansys.mechanical.core.logging import Logger
 LOG = Logger(level=logging.ERROR, to_file=False, to_stdout=True)
 """Create logger for package level use."""
 
-LOG.debug("Loaded logging module as LOG")
 
 from ansys.mechanical.core._version import __version__
+
+# import few classes / functions
 from ansys.mechanical.core.mechanical import (
+    Mechanical,
     change_default_mechanical_path,
     close_all_local_instances,
     connect_to_mechanical,
@@ -55,9 +57,6 @@ from ansys.mechanical.core.mechanical import (
     launch_mechanical,
 )
 
-# import few classes / functions
-from ansys.mechanical.core.mechanical import Mechanical as Mechanical
-
 try:
     from ansys.mechanical.core.embedding import App, global_variables
 

ansys/mechanical/core/embedding/app.py

@@ -30,6 +30,7 @@ import shutil
 import typing
 import warnings
 
+from ansys.mechanical.core import LOG
 from ansys.mechanical.core.embedding import initializer, runtime
 from ansys.mechanical.core.embedding.addins import AddinConfiguration
 from ansys.mechanical.core.embedding.appdata import UniqueUserProfile
@@ -46,10 +47,10 @@ if typing.TYPE_CHECKING:
 try:
     import ansys.tools.visualization_interface  # noqa: F401
 
-    HAS_ANSYS_VIZ = True
+    HAS_ANSYS_GRAPHICS = True
     """Whether or not PyVista exists."""
 except ImportError:
-    HAS_ANSYS_VIZ = False
+    HAS_ANSYS_GRAPHICS = False
 
 
 def _get_default_addin_configuration() -> AddinConfiguration:
@@ -89,6 +90,11 @@ def _start_application(configuration: AddinConfiguration, version, db_file) -> "
         return Ansys.Mechanical.Embedding.Application(db_file)
 
 
+def is_initialized():
+    """Check if the app has been initialized."""
+    return len(INSTANCES) != 0
+
+
 class GetterWrapper(object):
     """Wrapper class around an attribute of an object."""
 
@@ -124,10 +130,17 @@ class App:
     private_appdata : bool, optional
         Setting for a temporary AppData directory. Default is False.
         Enables running parallel instances of Mechanical.
+    globals : dict, optional
+        Global variables to be updated. For example, globals().
+        Replaces "app.update_globals(globals())".
     config : AddinConfiguration, optional
         Configuration for addins. By default "Mechanical" is used and ACT Addins are disabled.
     copy_profile : bool, optional
         Whether to copy the user profile when private_appdata is True. Default is True.
+    enable_logging : bool, optional
+        Whether to enable logging. Default is True.
+    log_level : str, optional
+        The logging level for the application. Default is "WARNING".
 
     Examples
     --------
@@ -140,6 +153,10 @@ class App:
 
     >>> app = App(private_appdata=True, copy_profile=False)
 
+    Update the global variables with globals
+
+    >>> app = App(globals=globals())
+
     Create App with "Mechanical" configuration and no ACT Addins
 
     >>> from ansys.mechanical.core.embedding import AddinConfiguration
@@ -147,6 +164,13 @@ class App:
     >>> config = AddinConfiguration("Mechanical")
     >>> config.no_act_addins = True
     >>> app = App(config=config)
+
+    Set log level
+
+    >>> app = App(log_level='INFO')
+
+    ... INFO -  -  app - log_info - Starting Mechanical Application
+
     """
 
     def __init__(self, db_file=None, private_appdata=False, **kwargs):
@@ -154,15 +178,36 @@ class App:
         global INSTANCES
         from ansys.mechanical.core import BUILDING_GALLERY
 
+        self._enable_logging = kwargs.get("enable_logging", True)
+        if self._enable_logging:
+            self._log = LOG
+            self._log_level = kwargs.get("log_level", "WARNING")
+            self._log.setLevel(self._log_level)
+
+        self.log_info("Starting Mechanical Application")
+
+        # Get the globals dictionary from kwargs
+        globals = kwargs.get("globals")
+
+        # If the building gallery flag is set, we need to share the instance
+        # This can apply to running the `make -C doc html` command
         if BUILDING_GALLERY:
             if len(INSTANCES) != 0:
+                # Get the first instance of the app
                 instance: App = INSTANCES[0]
+                # Point to the same underlying application object
                 instance._share(self)
+                # Update the globals if provided in kwargs
+                if globals:
+                    # The next line is covered by test_globals_kwarg_building_gallery
+                    instance.update_globals(globals)  # pragma: nocover
+                # Open the mechdb file if provided
                 if db_file is not None:
                     self.open(db_file)
                 return
         if len(INSTANCES) > 0:
             raise Exception("Cannot have more than one embedded mechanical instance!")
+
         version = kwargs.get("version")
         if version is not None:
             try:
@@ -179,7 +224,6 @@ class App:
             new_profile_name = f"PyMechanical-{os.getpid()}"
             profile = UniqueUserProfile(new_profile_name, copy_profile=copy_profile)
             profile.update_environment(os.environ)
-            atexit.register(_cleanup_private_appdata, profile)
 
         runtime.initialize(self._version)
         self._app = _start_application(configuration, self._version, db_file)
@@ -189,8 +233,16 @@ class App:
         self._disposed = False
         atexit.register(_dispose_embedded_app, INSTANCES)
         INSTANCES.append(self)
+
+        # Clean up the private appdata directory on exit if private_appdata is True
+        if private_appdata:
+            atexit.register(_cleanup_private_appdata, profile)
+
         self._updated_scopes: typing.List[typing.Dict[str, typing.Any]] = []
         self._subscribe()
+        self._messages = None
+        if globals:
+            self.update_globals(globals)
 
     def __repr__(self):
         """Get the product info."""
@@ -227,6 +279,7 @@ class App:
         remove_lock : bool, optional
             Whether or not to remove the lock file if it exists before opening the project file.
         """
+        self.log_info(f"Opening {db_file} ...")
         if remove_lock:
             lock_file = Path(self.DataModel.Project.ProjectDirectory) / ".mech_lock"
             # Remove the lock file if it exists before opening the project file
@@ -352,27 +405,27 @@ This may corrupt the project file.",
 
     def plotter(self) -> None:
         """Return ``ansys.tools.visualization_interface.Plotter`` object."""
-        if not HAS_ANSYS_VIZ:
-            warnings.warn(
-                "Installation of viz option required! Use pip install ansys-mechanical-core[viz]"
+        if not HAS_ANSYS_GRAPHICS:
+            LOG.warning(
+                "Use ``pip install ansys-mechanical-core[graphics]`` to enable this option."
             )
             return
 
         if self.version < 242:
-            warnings.warn("Plotting is only supported with version 2024R2 and later!")
+            LOG.warning("Plotting is only supported with version 2024R2 and later!")
             return
 
         # TODO Check if anything loaded inside app or else show warning and return
 
-        from ansys.mechanical.core.embedding.viz.embedding_plotter import to_plotter
+        from ansys.mechanical.core.embedding.graphics.embedding_plotter import to_plotter
 
         return to_plotter(self)
 
     def plot(self) -> None:
         """Visualize the model in 3d.
 
-        Requires installation using the viz option. E.g.
-        pip install ansys-mechanical-core[viz]
+        Requires installation using the graphics option. E.g.
+        pip install ansys-mechanical-core[graphics]
 
         Examples
         --------
@@ -437,6 +490,15 @@ This may corrupt the project file.",
         """Returns the current project directory."""
         return self.DataModel.Project.ProjectDirectory
 
+    @property
+    def messages(self):
+        """Lazy-load the MessageManager."""
+        if self._messages is None:
+            from ansys.mechanical.core.embedding.messages import MessageManager
+
+            self._messages = MessageManager(self._app)
+        return self._messages
+
     def _share(self, other) -> None:
         """Shares the state of self with other.
 
@@ -580,8 +642,7 @@ This may corrupt the project file.",
         Examples
         --------
         >>> from ansys.mechanical.core import App
-        >>> app = App()
-        >>> app.update_globals(globals())
+        >>> app = App(globals=globals())
         >>> app.print_tree()
         ... ├── Project
         ... |  ├── Model
@@ -608,3 +669,27 @@ This may corrupt the project file.",
             node = self.DataModel.Project
 
         self._print_tree(node, max_lines, lines_count, indentation)
+
+    def log_debug(self, message):
+        """Log the debug message."""
+        if not self._enable_logging:
+            return
+        self._log.debug(message)
+
+    def log_info(self, message):
+        """Log the info message."""
+        if not self._enable_logging:
+            return
+        self._log.info(message)
+
+    def log_warning(self, message):
+        """Log the warning message."""
+        if not self._enable_logging:
+            return
+        self._log.warning(message)
+
+    def log_error(self, message):
+        """Log the error message."""
+        if not self._enable_logging:
+            return
+        self._log.error(message)

ansys/mechanical/core/embedding/appdata.py

@@ -22,7 +22,7 @@
 
 """Temporary Appdata for Ansys Mechanical."""
 
-import os
+from pathlib import Path
 import shutil
 import sys
 import warnings
@@ -33,8 +33,8 @@ class UniqueUserProfile:
 
     def __init__(self, profile_name: str, copy_profile: bool = True, dry_run: bool = False):
         """Initialize UniqueUserProfile class."""
-        self._default_profile = os.path.expanduser("~")
-        self._location = os.path.join(self._default_profile, "PyMechanical-AppData", profile_name)
+        self._default_profile = Path("~").expanduser()
+        self._location = self._default_profile / "PyMechanical-AppData" / profile_name
         self._dry_run = dry_run
         self.copy_profile = copy_profile
         self.initialize()
@@ -58,15 +58,14 @@ class UniqueUserProfile:
         """Cleanup unique user profile."""
         if self._dry_run:
             return
-        text = "The `private_appdata` option was used, but the following files were not removed: "
-        message = []
 
-        def onerror(function, path, excinfo):
-            if len(message) == 0:
-                message.append(f"{text}{path}")
-                warnings.warn(message[0])
+        # Remove the appdata directory if it exists
+        shutil.rmtree(self.location, ignore_errors=True)
 
-        shutil.rmtree(self.location, onerror=onerror)
+        if self.location.is_dir():
+            warnings.warn(
+                f"The `private appdata` option was used, but {self.location} was not removed"
+            )
 
     @property
     def location(self) -> str:
@@ -77,28 +76,32 @@ class UniqueUserProfile:
         """Set environment variables for new user profile."""
         home = self.location
         if "win" in sys.platform:
-            env["USERPROFILE"] = home
-            env["APPDATA"] = os.path.join(home, "AppData/Roaming")
-            env["LOCALAPPDATA"] = os.path.join(home, "AppData/Local")
-            env["TMP"] = os.path.join(home, "AppData/Local/Temp")
-            env["TEMP"] = os.path.join(home, "AppData/Local/Temp")
+            appdata_dir = home / "AppData"
+            appdata_local_temp = str(appdata_dir / "Local" / "Temp")
+
+            env["USERPROFILE"] = str(home)
+            env["APPDATA"] = str(appdata_dir / "Roaming")
+            env["LOCALAPPDATA"] = str(appdata_dir / "Local")
+            env["TMP"] = appdata_local_temp
+            env["TEMP"] = appdata_local_temp
         elif "lin" in sys.platform:
-            env["HOME"] = home
+            env["HOME"] = str(home)
 
     def exists(self) -> bool:
         """Check if unique profile name already exists."""
-        return os.path.exists(self.location)
+        return self.location.exists()
 
     def mkdirs(self) -> None:
         """Create a unique user profile & set up the directory tree."""
-        os.makedirs(self.location, exist_ok=True)
+        self.location.mkdir(parents=True, exist_ok=True)
         if "win" in sys.platform:
             locs = ["AppData/Roaming", "AppData/Local", "Documents"]
         elif "lin" in sys.platform:
             locs = [".config", "temp/reports"]
 
         for loc in locs:
-            os.makedirs(os.path.join(self.location, loc))
+            dir_name = self.location / loc
+            dir_name.mkdir(parents=True, exist_ok=True)
 
     def copy_profiles(self) -> None:
         """Copy current user directories into a new user profile."""
@@ -107,6 +110,7 @@ class UniqueUserProfile:
         elif "lin" in sys.platform:
             locs = [".mw/Application Data/Ansys", ".config/Ansys"]
         for loc in locs:
-            shutil.copytree(
-                os.path.join(self._default_profile, loc), os.path.join(self.location, loc)
-            )
+            default_profile_loc = self._default_profile / loc
+            temp_appdata_loc = self.location / loc
+            if default_profile_loc.exists():
+                shutil.copytree(default_profile_loc, temp_appdata_loc)

ansys/mechanical/core/embedding/enum_importer.py

@@ -26,6 +26,11 @@ A useful subset of what is imported by
 Ansys Inc/v{NNN}/ACT/apis/Mechanical.py
 """
 
+from ansys.mechanical.core.embedding.app import is_initialized
+
+if not is_initialized():
+    raise Exception("Enums cannot be imported until the embedded app is initialized.")
+
 import clr
 
 clr.AddReference("Ansys.Mechanical.DataModel")

ansys/mechanical/core/embedding/global_importer.py

@@ -0,0 +1,50 @@
+# Copyright (C) 2022 - 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 Mechanical globals."""
+
+from ansys.mechanical.core.embedding.app import is_initialized
+
+if not is_initialized():
+    raise Exception("Globals cannot be imported until the embedded app is initialized.")
+
+import clr
+
+clr.AddReference("Ansys.Mechanical.DataModel")
+clr.AddReference("Ansys.ACT.Interfaces")
+
+
+clr.AddReference("System.Collections")
+clr.AddReference("Ansys.ACT.WB1")
+clr.AddReference("Ansys.Mechanical.DataModel")
+
+# from Ansys.ACT.Mechanical import Transaction
+# When ansys-pythonnet issue #14 is fixed, uncomment above
+from Ansys.ACT.Core.Math import Point2D, Point3D  # noqa isort: skip
+from Ansys.ACT.Math import Vector3D  # noqa isort: skip
+from Ansys.Core.Units import Quantity  # noqa isort: skip
+from Ansys.Mechanical.DataModel import MechanicalEnums  # noqa isort: skip
+from Ansys.Mechanical.Graphics import Point, SectionPlane  # noqa isort: skip
+
+from ansys.mechanical.core.embedding.transaction import Transaction  # noqa isort: skip
+
+import System  # noqa isort: skip
+import Ansys  # noqa isort: skip

ansys/mechanical/core/embedding/{viz → graphics}/embedding_plotter.py

@@ -82,7 +82,7 @@ def to_plotter(app: "ansys.mechanical.core.embedding.App"):
         if np_coordinates is None or np_indices is None:
             continue
         pv_transform = _transform_to_pyvista(scenegraph_node.Transform)
-        polydata = pv.PolyData(np_coordinates, np_indices).transform(pv_transform)
+        polydata = pv.PolyData(np_coordinates, np_indices).transform(pv_transform, inplace=True)
         color = pv.Color(bgr_to_rgb_tuple(body.Color))
         plotter.plot(polydata, color=color, smooth_shading=True)
     return plotter

ansys/mechanical/core/embedding/imports.py

@@ -46,36 +46,37 @@ def global_variables(app: "ansys.mechanical.core.App", enums: bool = False) -> t
     To also import all the enums, set the parameter enums to true.
     """
     vars = global_entry_points(app)
-    import clr  # isort: skip
-
-    clr.AddReference("System.Collections")
-    clr.AddReference("Ansys.ACT.WB1")
-    clr.AddReference("Ansys.Mechanical.DataModel")
-    # from Ansys.ACT.Mechanical import Transaction
-    # When ansys-pythonnet issue #14 is fixed, uncomment above
-    from Ansys.ACT.Core.Math import Point2D, Point3D
-    from Ansys.ACT.Math import Vector3D
-    from Ansys.ACT.Mechanical.Fields import VariableDefinitionType
-    from Ansys.Core.Units import Quantity
-    from Ansys.Mechanical.DataModel import MechanicalEnums
-    from Ansys.Mechanical.Graphics import Point, SectionPlane
-
-    import System  # isort: skip
-    import Ansys  # isort: skip
-
-    vars["Quantity"] = Quantity
-    vars["System"] = System
-    vars["Ansys"] = Ansys
+
+    from ansys.mechanical.core.embedding.app import is_initialized
+    from ansys.mechanical.core.embedding.transaction import Transaction
+
     vars["Transaction"] = Transaction
-    vars["MechanicalEnums"] = MechanicalEnums
-    # Graphics
-    vars["Point"] = Point
-    vars["SectionPlane"] = SectionPlane
-    # Math
-    vars["Point2D"] = Point2D
-    vars["Point3D"] = Point3D
-    vars["Vector3D"] = Vector3D
-    vars["VariableDefinitionType"] = VariableDefinitionType
+
+    # Import modules if the app is initialized
+    if is_initialized():
+        from ansys.mechanical.core.embedding.global_importer import (
+            Ansys,
+            MechanicalEnums,
+            Point,
+            Point2D,
+            Point3D,
+            Quantity,
+            SectionPlane,
+            System,
+            Vector3D,
+        )
+
+        vars["Quantity"] = Quantity
+        vars["System"] = System
+        vars["Ansys"] = Ansys
+        vars["MechanicalEnums"] = MechanicalEnums
+        # Graphics
+        vars["Point"] = Point
+        vars["SectionPlane"] = SectionPlane
+        # Math
+        vars["Point2D"] = Point2D
+        vars["Point3D"] = Point3D
+        vars["Vector3D"] = Vector3D
 
     if enums:
         vars.update(get_all_enums())
@@ -95,32 +96,3 @@ def get_all_enums() -> typing.Dict[str, typing.Any]:
         if type(the_enum).__name__ == "CLRMetatype":
             enums[attr] = the_enum
     return enums
-
-
-class Transaction:  # When ansys-pythonnet issue #14 is fixed, this class will be removed
-    """
-    A class to speed up bulk user interactions using Ansys ACT Mechanical Transaction.
-
-    Example
-    -------
-    >>> with Transaction() as transaction:
-    ...     pass   # Perform bulk user interactions here
-    ...
-    """
-
-    def __init__(self):
-        """Initialize the Transaction class."""
-        import clr
-
-        clr.AddReference("Ansys.ACT.WB1")
-        import Ansys
-
-        self._transaction = Ansys.ACT.Mechanical.Transaction()
-
-    def __enter__(self):
-        """Enter the context of the transaction."""
-        return self
-
-    def __exit__(self, exc_type, exc_val, exc_tb):
-        """Exit the context of the transaction and disposes of resources."""
-        self._transaction.Dispose()

ansys/mechanical/core/embedding/initializer.py

@@ -30,6 +30,7 @@ import warnings
 
 from ansys.mechanical.core.embedding.loader import load_clr
 from ansys.mechanical.core.embedding.resolver import resolve
+from ansys.mechanical.core.mechanical import LOG
 
 INITIALIZED_VERSION = None
 """Constant for the initialized version."""
@@ -85,7 +86,6 @@ def _get_latest_default_version() -> int:
     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.")
 
@@ -94,13 +94,15 @@ def _get_latest_default_version() -> int:
         folder = os.path.basename(os.path.normpath(path))
         version = folder.split("v")[-1]
         versions_found.append(int(version))
+
+    LOG.info(f"Available versions of Mechanical: {versions_found}")
+
     latest_version = max(versions_found)
 
     if len(awp_roots) > 1:
-        warnings.warn(
+        LOG.warning(
             f"Multiple versions of Mechanical found! Using latest version {latest_version} ..."
         )
-
     return latest_version
 
 
@@ -110,6 +112,74 @@ def __check_python_interpreter_architecture() -> None:
         raise Exception("Mechanical Embedding requires a 64-bit Python environment.")
 
 
+def __windows_store_workaround(version: int) -> None:
+    """Workaround for Windows store.
+
+    See https://github.com/ansys/pymechanical/issues/1136
+
+    Windows store Python uses the Win32 API SetDefaultDllDirectories
+    so that the PATH environment variable isn't scanned for any DLL
+    dependency.
+
+    PyMechanical loads the embedding library which automatically sets
+    these Paths, but this uses the PATH environment variable which doesn't
+    work for Windows store Python.
+
+    We provide a workaround for versions 2024R2 and 2025R1 that sets
+    these paths using `os.add_dll_directory`.
+
+    Note:   This workaround does not include DLL paths used in FSI
+            mapping workflows.
+
+    Parameters
+    ----------
+    version : int
+        The version of Mechanical to set the DLL paths for.
+    """
+    # Nothing to do on Linux
+    if os.name != "nt":
+        return
+
+    # Nothing to do if it isn't a Windows store application
+    if r"Microsoft\WindowsApps" not in sys.executable:
+        return
+
+    # Get the AWP_ROOT environment variable for the specified version
+    awp_root = Path(os.environ[f"AWP_ROOT{version}"])
+    # Set paths to the aisol and framework DLLs
+    paths = [
+        awp_root / "aisol" / "bin" / "winx64",
+        awp_root / "Framework" / "bin" / "Win64",
+    ]
+    # Set the path to the tp directory within the AWP_ROOTXYZ directory
+    awp_root_tp = awp_root / "tp"
+    # Add paths to the IntelCompiler, IntelMKL, HDF5, and Qt DLLs for 2024R2 and 2025R1
+    if version == 242:
+        paths.extend(
+            [
+                awp_root_tp / "IntelCompiler" / "2023.1.0" / "winx64",
+                awp_root_tp / "IntelMKL" / "2023.1.0" / "winx64",
+                awp_root_tp / "hdf5" / "1.12.2" / "winx64",
+                awp_root_tp / "qt" / "5.15.16" / "winx64" / "bin",
+            ]
+        )
+    elif version == 251:
+        paths.extend(
+            [
+                awp_root_tp / "IntelCompiler" / "2023.1.0" / "winx64",
+                awp_root_tp / "IntelMKL" / "2023.1.0" / "winx64",
+                awp_root_tp / "hdf5" / "1.12.2" / "winx64",
+                awp_root_tp / "qt" / "5.15.17" / "winx64" / "bin",
+            ]
+        )
+    else:
+        return
+
+    # Add each path to the DLL search path
+    for path in paths:
+        os.add_dll_directory(str(path))
+
+
 def __set_environment(version: int) -> None:
     """Set environment variables to configure embedding."""
     if os.name == "nt":  # pragma: no cover
@@ -159,7 +229,7 @@ def __check_loaded_libs(version: int = None):  # pragma: no cover
     # 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(
+        LOG.warning(
             "libX11.so is loaded prior to initializing the Embedded Instance of Mechanical.\
                       Python will crash on shutdown..."
         )
@@ -186,6 +256,8 @@ def initialize(version: int = None):
 
     __set_environment(version)
 
+    __windows_store_workaround(version)
+
     __check_loaded_libs(version)
 
     __workaround_material_server(version)