ansys-mechanical-core 0.11.2__tar.gz → 0.11.4__tar.gz

{ansys_mechanical_core-0.11.2 → ansys_mechanical_core-0.11.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: ansys-mechanical-core
-Version: 0.11.2
+Version: 0.11.4
 Summary: A python wrapper for Ansys Mechanical
 Keywords: pymechanical,mechanical,ansys,pyansys
 Author-email: "ANSYS, Inc." <pyansys.core@ansys.com>
@@ -27,36 +27,36 @@ Requires-Dist: clr-loader==0.2.6
 Requires-Dist: grpcio>=1.30.0
 Requires-Dist: protobuf>=3.12.2,<6
 Requires-Dist: tqdm>=4.45.0
-Requires-Dist: sphinx==7.4.4 ; extra == "doc"
+Requires-Dist: sphinx==7.4.7 ; extra == "doc"
 Requires-Dist: ansys-sphinx-theme[autoapi]==0.16.6 ; extra == "doc"
-Requires-Dist: grpcio==1.64.1 ; extra == "doc"
+Requires-Dist: grpcio==1.65.4 ; extra == "doc"
 Requires-Dist: imageio-ffmpeg==0.5.1 ; extra == "doc"
 Requires-Dist: imageio==2.34.2 ; extra == "doc"
 Requires-Dist: jupyter_sphinx==0.5.3 ; extra == "doc"
 Requires-Dist: jupyterlab>=3.2.8 ; extra == "doc"
 Requires-Dist: matplotlib==3.9.1 ; extra == "doc"
-Requires-Dist: numpy==2.0.0 ; extra == "doc"
+Requires-Dist: numpy==2.0.1 ; extra == "doc"
 Requires-Dist: numpydoc==1.7.0 ; extra == "doc"
 Requires-Dist: pandas==2.2.2 ; extra == "doc"
 Requires-Dist: panel==1.4.4 ; extra == "doc"
-Requires-Dist: plotly==5.22.0 ; extra == "doc"
+Requires-Dist: plotly==5.23.0 ; extra == "doc"
 Requires-Dist: pypandoc==1.13 ; 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.2 ; extra == "doc"
+Requires-Dist: sphinx-autodoc-typehints==2.2.3 ; extra == "doc"
 Requires-Dist: sphinx-copybutton==0.5.2 ; extra == "doc"
 Requires-Dist: sphinx_design==0.6.0 ; extra == "doc"
-Requires-Dist: sphinx-gallery==0.16.0 ; extra == "doc"
+Requires-Dist: sphinx-gallery==0.17.0 ; extra == "doc"
 Requires-Dist: sphinx-notfound-page==1.0.2 ; extra == "doc"
-Requires-Dist: sphinxcontrib-websupport==1.2.7 ; extra == "doc"
+Requires-Dist: sphinxcontrib-websupport==2.0.0 ; extra == "doc"
 Requires-Dist: sphinxemoji==0.3.1 ; extra == "doc"
-Requires-Dist: pytest==8.2.2 ; extra == "tests"
+Requires-Dist: pytest==8.3.2 ; extra == "tests"
 Requires-Dist: pytest-cov==5.0.0 ; extra == "tests"
 Requires-Dist: pytest-print==1.0.0 ; extra == "tests"
-Requires-Dist: pyvista>=0.39.1 ; extra == "viz"
-Requires-Dist: usd-core==24.3 ; extra == "viz"
+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
 Project-URL: Documentation, https://mechanical.docs.pyansys.com
 Project-URL: Homepage, https://github.com/ansys/pymechanical
@@ -187,7 +187,8 @@ on Windows and Linux for version 2023 R2 and later. Here is an example:
    import ansys.mechanical.core as pymechanical
 
    app = pymechanical.App()
-   project_dir = app.ExtAPI.DataModel.Project.ProjectDirectory
+   app.update_globals(globals())
+   project_dir = DataModel.Project.ProjectDirectory
 
 Documentation and issues
 ------------------------

{ansys_mechanical_core-0.11.2 → ansys_mechanical_core-0.11.4}/README.rst

@@ -119,7 +119,8 @@ on Windows and Linux for version 2023 R2 and later. Here is an example:
    import ansys.mechanical.core as pymechanical
 
    app = pymechanical.App()
-   project_dir = app.ExtAPI.DataModel.Project.ProjectDirectory
+   app.update_globals(globals())
+   project_dir = DataModel.Project.ProjectDirectory
 
 Documentation and issues
 ------------------------

{ansys_mechanical_core-0.11.2 → ansys_mechanical_core-0.11.4}/pyproject.toml

@@ -5,7 +5,7 @@ build-backend = "flit_core.buildapi"
 [project]
 # Check https://flit.readthedocs.io/en/latest/pyproject_toml.html for all available sections
 name = "ansys-mechanical-core"
-version = "0.11.2"
+version = "0.11.4"
 description = "A python wrapper for Ansys Mechanical"
 readme = "README.rst"
 requires-python = ">=3.9,<4.0"
@@ -48,40 +48,40 @@ Changelog = "https://mechanical.docs.pyansys.com/version/stable/changelog.html"
 
 [project.optional-dependencies]
 tests = [
-    "pytest==8.2.2",
+    "pytest==8.3.2",
     "pytest-cov==5.0.0",
     "pytest-print==1.0.0",
 ]
 doc = [
-    "sphinx==7.4.4",
+    "sphinx==7.4.7",
     "ansys-sphinx-theme[autoapi]==0.16.6",
-    "grpcio==1.64.1",
+    "grpcio==1.65.4",
     "imageio-ffmpeg==0.5.1",
     "imageio==2.34.2",
     "jupyter_sphinx==0.5.3",
     "jupyterlab>=3.2.8",
     "matplotlib==3.9.1",
-    "numpy==2.0.0",
+    "numpy==2.0.1",
     "numpydoc==1.7.0",
     "pandas==2.2.2",
     "panel==1.4.4",
-    "plotly==5.22.0",
+    "plotly==5.23.0",
     "pypandoc==1.13",
     "pytest-sphinx==0.6.3",
     "pythreejs==2.4.2",
     "pyvista>=0.39.1",
     "sphinx-autobuild==2024.4.16",
-    "sphinx-autodoc-typehints==2.2.2",
+    "sphinx-autodoc-typehints==2.2.3",
     "sphinx-copybutton==0.5.2",
     "sphinx_design==0.6.0",
-    "sphinx-gallery==0.16.0",
+    "sphinx-gallery==0.17.0",
     "sphinx-notfound-page==1.0.2",
-    "sphinxcontrib-websupport==1.2.7",
+    "sphinxcontrib-websupport==2.0.0",
     "sphinxemoji==0.3.1",
 ]
 viz = [
-    "pyvista>=0.39.1",
-    "usd-core==24.3",
+    "ansys-tools-visualization-interface>=0.2.6",
+    "usd-core==24.8",
 ]
 
 [project.scripts]
@@ -139,6 +139,7 @@ markers = [
     "remote_session_connect: tests that connect to Mechanical and work with gRPC server inside it",
     "minimum_version(num): tests that run if ansys-version is greater than or equal to the minimum version provided",
     "windows_only: tests that run if the testing platform is on Windows",
+    "linux_only: tests that run if the testing platform is on Linux",
     "cli: tests for the Command Line Interface",
 ]
 xfail_strict = true
@@ -152,7 +153,6 @@ package = "ansys.mechanical.core"
 directory = "doc/changelog.d"
 filename = "doc/source/changelog.rst"
 start_string = ".. towncrier release notes start\n"
-underlines = ["", "", ""]
 template = "doc/changelog.d/changelog_template.jinja"
 title_format = "`{version} <https://github.com/ansys/pymechanical/releases/tag/v{version}>`_ - {project_date}"
 issue_format = "`#{issue} <https://github.com/ansys/pymechanical/pull/{issue}>`_"
@@ -207,7 +207,7 @@ legacy_tox_ini = """
 [tox]
 description = Default tox environments list
 envlist =
-    style,{py38,py39,py310,py311}{,-coverage},doc
+    style,{py39,py310,py311,py312}{,-coverage},doc
 passenv =  AWP_ROOT
 skip_missing_interpreters = true
 isolated_build = true
@@ -254,4 +254,18 @@ passenv = *
 extras = doc
 commands =
     sphinx-build -d "{toxworkdir}/doc_doctree" doc/source "{toxinidir}/doc/_build/html" --color -vW -bhtml
-"""
+"""
+[[tool.towncrier.type]]
+directory = "documentation"
+name = "Documentation"
+showcontent = true
+
+[[tool.towncrier.type]]
+directory = "maintenance"
+name = "Maintenance"
+showcontent = true
+
+[[tool.towncrier.type]]
+directory = "test"
+name = "Test"
+showcontent = true

{ansys_mechanical_core-0.11.2 → ansys_mechanical_core-0.11.4}/src/ansys/mechanical/core/embedding/app.py

@@ -34,13 +34,13 @@ from ansys.mechanical.core.embedding.poster import Poster
 from ansys.mechanical.core.embedding.warnings import connect_warnings, disconnect_warnings
 
 try:
-    import pyvista  # noqa: F401
+    import ansys.tools.visualization_interface  # noqa: F401
 
-    HAS_PYVISTA = True
+    HAS_ANSYS_VIZ = True
     """Whether or not PyVista exists."""
 except:
 
-    HAS_PYVISTA = False
+    HAS_ANSYS_VIZ = False
 
 
 def _get_default_addin_configuration() -> AddinConfiguration:
@@ -229,13 +229,9 @@ class App:
         rets = None
         return self.script_engine.ExecuteCode(script, SCRIPT_SCOPE, light_mode, args, rets)
 
-    def plot(self) -> None:
-        """Visualize the model in 3d.
-
-        Requires installation using the viz option. E.g.
-        pip install ansys-mechanical-core[viz]
-        """
-        if not HAS_PYVISTA:
+    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]"
             )
@@ -245,9 +241,20 @@ class App:
             warnings.warn("Plotting is only supported with version 2024R2 and later!")
             return
 
-        from ansys.mechanical.core.embedding.viz.pyvista_plotter import plot_model
+        # TODO Check if anything loaded inside app or else show warning and return
+
+        from ansys.mechanical.core.embedding.viz.embedding_plotter import to_plotter
+
+        return to_plotter(self)
 
-        plot_model(self)
+    def plot(self) -> None:
+        """Visualize the model in 3d.
+
+        Requires installation using the viz option. E.g.
+        pip install ansys-mechanical-core[viz]
+        """
+        _plotter = self.plotter()
+        return _plotter.show()
 
     @property
     def poster(self) -> Poster:
@@ -328,8 +335,7 @@ class App:
         try:
             # This will throw an error when using pythonnet because
             # EventSource isn't defined on the IApplication interface
-            self.ExtAPI.Application.EventSource.OnAfterNew += self._on_after_new
-            self.ExtAPI.Application.EventSource.OnAfterDatabaseLoad += self._on_after_open
+            self.ExtAPI.Application.EventSource.OnWorkbenchReady += self._on_workbench_ready
             self._subscribed = True
         except:
             self._subscribed = False
@@ -338,13 +344,9 @@ class App:
         if not self._subscribed:
             return
         self._subscribed = False
-        self.ExtAPI.Application.EventSource.OnAfterNew -= self._on_after_new
-        self.ExtAPI.Application.EventSource.OnAfterDatabaseLoad -= self._on_after_open
-
-    def _on_after_open(self, sender, args) -> None:
-        self._update_all_globals()
+        self.ExtAPI.Application.EventSource.OnWorkbenchReady -= self._on_workbench_ready
 
-    def _on_after_new(self, sender, args) -> None:
+    def _on_workbench_ready(self, sender, args) -> None:
         self._update_all_globals()
 
     def update_globals(

ansys_mechanical_core-0.11.4/src/ansys/mechanical/core/embedding/background.py

@@ -0,0 +1,106 @@
+# 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.
+
+"""Class for running Mechanical on a background thread."""
+
+import atexit
+import threading
+import time
+import typing
+
+import ansys.mechanical.core as mech
+from ansys.mechanical.core.embedding.poster import Poster
+import ansys.mechanical.core.embedding.utils as utils
+
+
+def _exit(background_app: "BackgroundApp"):
+    """Stop the thread serving the Background App."""
+    background_app.stop()
+    atexit.unregister(_exit)
+
+
+class BackgroundApp:
+    """Background App."""
+
+    __app: mech.App = None
+    __app_thread: threading.Thread = None
+    __stopped: bool = False
+    __stop_signaled: bool = False
+    __poster: Poster = None
+
+    def __init__(self, **kwargs):
+        """Construct an instance of BackgroundApp."""
+        if BackgroundApp.__app_thread == None:
+            BackgroundApp.__app_thread = threading.Thread(
+                target=self._start_app, kwargs=kwargs, daemon=True
+            )
+            BackgroundApp.__app_thread.start()
+
+            while BackgroundApp.__poster is None:
+                time.sleep(0.05)
+                continue
+        else:
+            assert (
+                not BackgroundApp.__stopped
+            ), "Cannot initialize a BackgroundApp once it has been stopped!"
+
+            def new():
+                BackgroundApp.__app.new()
+
+            self.post(new)
+
+        atexit.register(_exit, self)
+
+    @property
+    def app(self) -> mech.App:
+        """Get the App instance of the background thread.
+
+        It is not meant to be used aside from passing to methods using `post`.
+        """
+        return BackgroundApp.__app
+
+    def post(self, callable: typing.Callable):
+        """Post callable method to the background app thread."""
+        assert not BackgroundApp.__stopped, "Cannot use background app after stopping it."
+        return BackgroundApp.__poster.post(callable)
+
+    def stop(self) -> None:
+        """Stop the background app thread."""
+        if BackgroundApp.__stopped:
+            return
+        BackgroundApp.__stop_signaled = True
+        while True:
+            time.sleep(0.05)
+            if BackgroundApp.__stopped:
+                break
+
+    def _start_app(self, **kwargs) -> None:
+        BackgroundApp.__app = mech.App(**kwargs)
+        BackgroundApp.__poster = BackgroundApp.__app.poster
+        while True:
+            if BackgroundApp.__stop_signaled:
+                break
+            try:
+                utils.sleep(40)
+            except:
+                pass
+        BackgroundApp.__stopped = True

{ansys_mechanical_core-0.11.2 → ansys_mechanical_core-0.11.4}/src/ansys/mechanical/core/embedding/resolver.py

@@ -37,8 +37,5 @@ def resolve(version):
     import Ansys  # isort: skip
 
     assembly_resolver = Ansys.Mechanical.Embedding.AssemblyResolver
-    if version == 231:  # pragma: no cover
-        resolve_handler = assembly_resolver.WindowsResolveEventHandler
-    else:
-        resolve_handler = assembly_resolver.MechanicalResolveEventHandler
+    resolve_handler = assembly_resolver.MechanicalResolveEventHandler
     System.AppDomain.CurrentDomain.AssemblyResolve += resolve_handler

{ansys_mechanical_core-0.11.2 → ansys_mechanical_core-0.11.4}/src/ansys/mechanical/core/embedding/shims.py

@@ -25,16 +25,17 @@
 These shims are used when APIs are released in newer versions of Mechanical,
 but workarounds exist in an older release
 """
+import warnings
 
 
 def import_materials(
     app: "ansys.mechanical.core.embedding.Application", material_file: str
 ) -> None:
     """Import material from matml file."""
-    if app._version >= 232:
-        materials = app.DataModel.Project.Model.Materials
-        materials.Import(material_file)
-    else:  # pragma: no cover
-        material_file = material_file.replace("\\", "\\\\")
-        script = 'DS.Tree.Projects.Item(1).LoadEngrDataLibraryFromFile("' + material_file + '");'
-        app.ExtAPI.Application.ScriptByName("jscript").ExecuteCommand(script)
+    warnings.warn(
+        "Use of this function is deprecated. Use Model.Materials.Import() directly.",
+        DeprecationWarning,
+        stacklevel=2,
+    )
+    materials = app.DataModel.Project.Model.Materials
+    materials.Import(material_file)

ansys_mechanical_core-0.11.2/src/ansys/mechanical/core/embedding/viz/pyvista_plotter.py → ansys_mechanical_core-0.11.4/src/ansys/mechanical/core/embedding/viz/embedding_plotter.py

@@ -29,6 +29,7 @@ clr.AddReference("Ansys.ACT.Interfaces")
 
 import Ansys  # isort: skip
 
+from ansys.tools.visualization_interface import Plotter
 import numpy as np
 import pyvista as pv
 
@@ -68,9 +69,9 @@ def _get_nodes_and_coords(node: "Ansys.Mechanical.Scenegraph.Node"):
     return None, None
 
 
-def to_pyvista_plotter(app: "ansys.mechanical.core.embedding.App"):
-    """Convert the app's geometry to a pyvista plotter instance."""
-    plotter = pv.Plotter()
+def to_plotter(app: "ansys.mechanical.core.embedding.App"):
+    """Convert the app's geometry to an ``ansys.tools.visualization_interface.Plotter`` instance."""
+    plotter = Plotter()
     for body in app.DataModel.GetObjectsByType(
         Ansys.Mechanical.DataModel.Enums.DataModelObjectCategory.Body
     ):
@@ -81,11 +82,5 @@ def to_pyvista_plotter(app: "ansys.mechanical.core.embedding.App"):
         pv_transform = _transform_to_pyvista(scenegraph_node.Transform)
         polydata = pv.PolyData(np_coordinates, np_indices).transform(pv_transform)
         color = pv.Color(bgr_to_rgb_tuple(body.Color))
-        plotter.add_mesh(polydata, color=color, smooth_shading=True)
+        plotter.plot(polydata, color=color, smooth_shading=True)
     return plotter
-
-
-def plot_model(app: "ansys.mechanical.core.embedding.App"):
-    """Plot the model."""
-    plotter = to_pyvista_plotter(app)
-    plotter.show()

{ansys_mechanical_core-0.11.2 → ansys_mechanical_core-0.11.4}/src/ansys/mechanical/core/mechanical.py

@@ -246,7 +246,7 @@ def check_valid_mechanical():
     if mechanical_path == None:
         return False
     mechanical_version = atp.version_from_path("mechanical", mechanical_path)
-    return not (mechanical_version < 231 and os.name != "posix")
+    return not (mechanical_version < 232 and os.name != "posix")
 
 
 def change_default_mechanical_path(exe_loc):
@@ -1913,8 +1913,8 @@ def launch_grpc(
 
     """
     # verify version
-    if atp.version_from_path("mechanical", exec_file) < 231:
-        raise VersionError("The Mechanical gRPC interface requires Mechanical 2023 R1 or later.")
+    if atp.version_from_path("mechanical", exec_file) < 232:
+        raise VersionError("The Mechanical gRPC interface requires Mechanical 2023 R2 or later.")
 
     # get the next available port
     local_ports = pymechanical.LOCAL_PORTS

{ansys_mechanical_core-0.11.2 → ansys_mechanical_core-0.11.4}/src/ansys/mechanical/core/pool.py

@@ -170,7 +170,7 @@ class LocalMechanicalPool:
         self._spawn_kwargs = kwargs
         self._remote = False
 
-        # verify that mechanical is 2023R1 or newer
+        # verify that mechanical is 2023R2 or newer
         exec_file = None
         if "exec_file" in kwargs:
             exec_file = kwargs["exec_file"]
@@ -191,8 +191,8 @@ class LocalMechanicalPool:
                     )
 
         if not self._remote:  # pragma: no cover
-            if version_from_path("mechanical", exec_file) < 231:
-                raise VersionError("A local Mechanical pool requires Mechanical 2023 R1 or later.")
+            if version_from_path("mechanical", exec_file) < 232:
+                raise VersionError("A local Mechanical pool requires Mechanical 2023 R2 or later.")
 
         ports = None