ansys-pyensight-core 0.8.4__py3-none-any.whl → 0.8.5__py3-none-any.whl

ansys/pyensight/core/exts/ansys.geometry.serviceui/config/extension.toml

@@ -0,0 +1,49 @@
+[package]
+# Semantic Versioning is used: https://semver.org/
+version = "0.8.5"
+
+# Lists people or organizations that are considered the "authors" of the package.
+authors = ["ANSYS"]
+
+# The title and description fields are primarily for displaying extension info in UI
+title = "ANSYS Omniverse Geometry Service GUI"
+description = "A geometry synchronization service that enables export of geometry scenes from ANSYS products to Omniverse."
+
+# Path (relative to the root) or content of readme markdown file for UI.
+readme  = "docs/README.md"
+
+# URL of the extension source repository.
+repository = "https://github.com/ansys/pyensight"
+
+# One of categories for UI.
+category = "simulation"
+
+# Keywords for the extension
+keywords = ["ANSYS", "EnSight", "PyEnSight", "Fluent", "kit"]
+
+# Location of change log file in target (final) folder of extension, relative to the root.
+# More info on writing changelog: https://keepachangelog.com/en/1.0.0/
+changelog = "docs/CHANGELOG.md"
+
+# Preview image and icon. Folder named "data" automatically goes in git lfs (see .gitattributes file).
+# Preview image is shown in "Overview" of Extensions window. Screenshot of an extension might be a good preview image.
+preview_image = "data/preview.png"
+
+# Icon is shown in Extensions window, it is recommended to be square, of size 256x256.
+icon = "data/icon.png"
+
+# Use omni.ui to build simple UI
+[dependencies]
+"omni.kit.uiapp" = {}
+"ansys.geometry.service" = {}
+
+# Main python module this extension provides, it will be publicly available as "import ansys.geometry.serviceui".
+[[python.module]]
+name = "ansys.geometry.serviceui"
+
+[[test]]
+# Extra dependencies only to be used during test run
+dependencies = [
+    "omni.kit.ui_test" # UI testing extension
+]
+

ansys/pyensight/core/exts/ansys.geometry.serviceui/docs/CHANGELOG.md

@@ -0,0 +1,8 @@
+# Changelog
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
+
+
+## [0.9.0] - 2024-06-28
+- Initial kit version of ANSYS Geometry Service GUI
+

ansys/pyensight/core/exts/ansys.geometry.serviceui/docs/README.md

@@ -0,0 +1,13 @@
+# ANSYS Omniverse Geometry Service GUI [ansys.geometry.serviceui]
+
+This Omniverse extension is a UI interface to the [ansys.geometry.service]
+kit extension.  It allows an Omniverse application user to connect to
+a running copy of ANSYS EnSight or other application that supports the
+Dynamic Scene Graph gRPC protocol.  The GUI allows for the remote scene
+to be pulled, on request,  into a specified Omniverse location.
+
+
+For more details on this extension see:
+https://ensight.docs.pyansys.com/version/dev/user_guide/omniverse_info.html
+
+

ansys/pyensight/core/exts/ansys.geometry.serviceui/docs/index.rst

@@ -0,0 +1,18 @@
+ansys.geometry.serviceui
+########################
+
+
+.. toctree::
+   :maxdepth: 1
+
+   README
+   CHANGELOG
+
+
+.. automodule::"ansys.geometry.serviceui"
+    :platform: Windows-x86_64, Linux-x86_64
+    :members:
+    :undoc-members:
+    :show-inheritance:
+    :imported-members:
+    :exclude-members: contextmanager

ansys/pyensight/core/launcher.py

@@ -13,10 +13,13 @@ Examples:
 """
 import os.path
 import platform
+import random
+import re
 import socket
 from typing import TYPE_CHECKING, Dict, List, Optional
 import warnings
 
+import psutil
 import requests
 
 if TYPE_CHECKING:
@@ -165,6 +168,38 @@ class Launcher:
         """
         return
 
+    def _find_ports_used_by_other_pyensight_and_ensight(self):
+        """Find ports to avoid when looking for empty ports.
+
+        The ports are found iterating the current processes and
+        looking for PyEnSight/EnSight sessions and their command
+        lines.
+        """
+        pyensight_found = []
+        ensight_found = []
+        for process in psutil.process_iter():
+            try:
+                process_cmdline = process.cmdline()
+            except (psutil.AccessDenied, psutil.ZombieProcess):
+                continue
+            if not process_cmdline:
+                continue
+            if len(process_cmdline) > 1:
+                if "websocketserver.py" in os.path.basename(process_cmdline[1]):
+                    pyensight_found.append(process_cmdline)
+            if any(["ensight" in os.path.basename(x) for x in process_cmdline]):
+                if any([x == "-ports" for x in process_cmdline]):
+                    ensight_found.append(process_cmdline)
+        ports = []
+        for command_line in pyensight_found:
+            for command in command_line:
+                if re.match(r"^\d{4,5}$", command):
+                    ports.append(int(command))
+        for command_line in ensight_found:
+            idx = command_line.index("-ports") + 1
+            ports.append(int(command_line[idx]))
+        return list(set(ports))
+
     @staticmethod
     def _find_unused_ports(count: int, avoid: Optional[List[int]] = None) -> Optional[List[int]]:
         """Find "count" unused ports on the host system
@@ -191,7 +226,7 @@ class Launcher:
         ports = list()
 
         # pick a starting port number
-        start = os.getpid() % 64000
+        start = random.randint(1024, 64000)
         # We will scan for 65530 ports unless end is specified
         port_mod = 65530
         end = start + port_mod - 1

ansys/pyensight/core/locallauncher.py

@@ -123,7 +123,8 @@ class LocalLauncher(Launcher):
             self.session_directory = tempfile.mkdtemp(prefix="pyensight_")
 
             # gRPC port, VNC port, websocketserver ws, websocketserver html
-            self._ports = self._find_unused_ports(4)
+            to_avoid = self._find_ports_used_by_other_pyensight_and_ensight()
+            self._ports = self._find_unused_ports(5, avoid=to_avoid)
             if self._ports is None:
                 raise RuntimeError("Unable to allocate local ports for EnSight session")
             is_windows = self._is_windows()
@@ -152,6 +153,7 @@ class LocalLauncher(Launcher):
             cmd.extend(["-grpc_server", str(self._ports[0])])
             vnc_url = f"vnc://%%3Frfb_port={self._ports[1]}%%26use_auth=0"
             cmd.extend(["-vnc", vnc_url])
+            cmd.extend(["-ports", str(self._ports[4])])
 
             use_egl = self._use_egl()
 

ansys/pyensight/core/utils/dsg_server.py

@@ -1,6 +1,7 @@
 import logging
 import os
 import queue
+import sys
 import threading
 from typing import Any, Dict, List, Optional
 
@@ -94,7 +95,7 @@ class Part(object):
             else:
                 self.tcoords_var_id = None
 
-    def build(self):
+    def nodal_surface_rep(self):
         """
         This function processes the geometry arrays and converts them into nodal representation.
         It will duplicate triangles as needed (to preserve element normals) and will convert
@@ -115,10 +116,8 @@ class Part(object):
         """
         if self.cmd is None:
             return None, None, None, None, None, None
-        if self.conn_lines.size:
-            self.session.log(
-                f"Note: part '{self.cmd.name}' contains lines which are not currently supported."
-            )
+        if self.conn_tris.size == 0:
+            self.session.log(f"Note: part '{self.cmd.name}' contains no triangles.")
             return None, None, None, None, None, None
         verts = self.coords
         if self.session.normalize_geometry and self.session.scene_bounds is not None:
@@ -237,7 +236,7 @@ class Part(object):
             tcoords = tmp
 
         self.session.log(
-            f"Part '{self.cmd.name}' defined: {self.coords.size/3} verts, {self.conn_tris.size/3} tris, {self.conn_lines.size/2} lines."
+            f"Part '{self.cmd.name}' defined: {self.coords.size/3} verts, {self.conn_tris.size/3} tris."
         )
         command = self.cmd
 
@@ -395,11 +394,16 @@ class DSGSession(object):
         self._dsg = None
         self._normalize_geometry = normalize_geometry
         self._vrmode = vrmode
+        self._time_limits = [
+            sys.float_info.max,
+            -sys.float_info.max,
+        ]  # Min/max across all time steps
         self._mesh_block_count = 0
         self._variables: Dict[int, Any] = dict()
         self._groups: Dict[int, Any] = dict()
         self._part: Part = Part(self)
         self._scene_bounds: Optional[List] = None
+        self._cur_timeline: List = [0.0, 0.0]  # Start/End time for current update
         self._callback_handler.session = self
 
     @property
@@ -438,6 +442,20 @@ class DSGSession(object):
     def part(self) -> Part:
         return self._part
 
+    @property
+    def time_limits(self) -> List:
+        return self._time_limits
+
+    @property
+    def cur_timeline(self) -> List:
+        return self._cur_timeline
+
+    @cur_timeline.setter
+    def cur_timeline(self, timeline: List) -> None:
+        self._cur_timeline = timeline
+        self._time_limits[0] = min(self._time_limits[0], self._cur_timeline[0])
+        self._time_limits[1] = max(self._time_limits[1], self._cur_timeline[1])
+
     @property
     def grpc(self) -> ensight_grpc.EnSightGRPC:
         return self._grpc
@@ -483,7 +501,7 @@ class DSGSession(object):
     def end(self):
         """Stop a gRPC connection to the EnSight instance"""
         self._callback_handler.end_connection()
-        self._grpc.stop_server()
+        self._grpc.shutdown()
         self._shutdown = True
         self._thread.join()
         self._grpc.shutdown()
@@ -515,8 +533,6 @@ class DSGSession(object):
         cmd.init.allow_incremental_updates = False
         cmd.init.maximum_chunk_size = 1024 * 1024
         self._dsg_queue.put(cmd)  # type:ignore
-        # Handle the update messages
-        self.handle_one_update()
 
     def _poll_messages(self) -> None:
         """Core interface to grab DSG events from gRPC and queue them for processing
@@ -626,7 +642,6 @@ class DSGSession(object):
         There is always a part being modified.  This method completes the current part, committing
         it to the handler.
         """
-        self._part.build()
         self._callback_handler.finalize_part(self.part)
         self._mesh_block_count += 1
 
@@ -686,10 +701,13 @@ class DSGSession(object):
         """Handle a DSG UPDATE_VIEW command
 
         Parameters
-        ----------s
+        ----------
         view:
             The command coming from the EnSight stream.
         """
+        self._finish_part()
         self._scene_bounds = None
         self._groups[view.id] = view
+        if len(view.timeline) == 2:
+            self.cur_timeline = [view.timeline[0], view.timeline[1]]
         self._callback_handler.add_group(view.id, view=True)

ansys/pyensight/core/utils/omniverse.py

@@ -1,8 +1,9 @@
+import glob
 import os
 import subprocess
 import sys
 from types import ModuleType
-from typing import TYPE_CHECKING, List, Optional, Union
+from typing import TYPE_CHECKING, Optional, Union
 
 import psutil
 
@@ -12,6 +13,8 @@ if TYPE_CHECKING:
     except ImportError:
         from ansys.api.pyensight import ensight_api
 
+import ansys.pyensight.core
+
 
 class Omniverse:
     """Provides the ``ensight.utils.omniverse`` interface.
@@ -21,7 +24,7 @@ class Omniverse:
 
     Parameters
     ----------
-    interface:
+    interface: Union["ensight_api.ensight", "ensight"]
         Entity that provides the ``ensight`` namespace. In the case of
         EnSight Python, the ``ensight`` module is passed. In the case
         of PyEnSight, ``Session.ensight`` is passed.
@@ -35,20 +38,93 @@ class Omniverse:
 
     Examples
     --------
-    ::
-        from ansys.pyensight.core import LocalLauncher
-        session = LocalLauncher().start()
-        ov = session.ensight.utils.omniverse
-        ov.create_connection()
-        ov.update()
-        ov.close_connection()
+
+    >>> from ansys.pyensight.core import LocalLauncher
+    >>> session = LocalLauncher().start()
+    >>> ov = session.ensight.utils.omniverse
+    >>> ov.create_connection()
+    >>> ov.update()
+    >>> ov.close_connection()
 
     """
 
     def __init__(self, interface: Union["ensight_api.ensight", "ensight"]):
         self._ensight = interface
         self._server_pid: Optional[int] = None
-        self._interpreter: List[str] = []
+        self._interpreter: str = ""
+
+    @staticmethod
+    def find_kit_filename(fallback_directory: Optional[str] = None) -> Optional[str]:
+        """
+        Use a combination of the current omniverse application and the information
+        in the local .nvidia-omniverse/config/omniverse.toml file to come up with
+        the pathname of a kit executable suitable for hosting another copy of the
+        ansys.geometry.server kit.
+
+        Returns
+        -------
+        Optional[str]
+            The pathname of a kit executable or None
+
+        """
+        # parse the toml config file for the location of the installed apps
+        try:
+            import tomllib
+        except ModuleNotFoundError:
+            import pip._vendor.tomli as tomllib
+
+        homedir = os.path.expanduser("~")
+        ov_config = os.path.join(homedir, ".nvidia-omniverse", "config", "omniverse.toml")
+        if not os.path.exists(ov_config):
+            return None
+        # read the Omniverse configuration toml file
+        with open(ov_config, "r") as ov_file:
+            ov_data = ov_file.read()
+        config = tomllib.loads(ov_data)
+        appdir = config.get("paths", {}).get("library_root", fallback_directory)
+
+        # If we are running inside an Omniverse app, use that information
+        try:
+            import omni.kit.app
+
+            # get the current application
+            app = omni.kit.app.get_app()
+            app_name = app.get_app_filename().split(".")[-1]
+            app_version = app.get_app_version().split("-")[0]
+            # and where it is installed
+            appdir = os.path.join(appdir, f"{app_name}-{app_version}")
+        except ModuleNotFoundError:
+            # Names should be like: "C:\\Users\\foo\\AppData\\Local\\ov\\pkg\\create-2023.2.3\\launcher.toml"
+            target = None
+            target_version = None
+            for d in glob.glob(os.path.join(appdir, "*", "launcher.toml")):
+                test_dir = os.path.dirname(d)
+                # the name will be something like "create-2023.2.3"
+                name = os.path.basename(test_dir).split("-")
+                if len(name) != 2:
+                    continue
+                if name[0] not in ("kit", "create", "view"):
+                    continue
+                if (target_version is None) or (name[1] > target_version):
+                    target = test_dir
+                    target_version = name[1]
+            if target is None:
+                return None
+            appdir = target
+
+        # Windows: 'kit.bat' in '.' or 'kit' followed by 'kit.exe' in '.' or 'kit'
+        # Linux: 'kit.sh' in '.' or 'kit' followed by 'kit' in '.' or 'kit'
+        exe_names = ["kit.sh", "kit"]
+        if sys.platform.startswith("win"):
+            exe_names = ["kit.bat", "kit.exe"]
+
+        # look in 4 places...
+        for dir_name in [appdir, os.path.join(appdir, "kit")]:
+            for exe_name in exe_names:
+                if os.path.exists(os.path.join(dir_name, exe_name)):
+                    return os.path.join(dir_name, exe_name)
+
+        return None
 
     def _check_modules(self) -> None:
         """Verify that the Python interpreter is correct
@@ -60,53 +136,26 @@ class Omniverse:
 
         Raises
         ------
-        RuntimeError if the necessary modules are missing.
+        RuntimeError
+            if the necessary modules are missing.
 
         """
         # One time check for this
         if len(self._interpreter):
             return
-        try:
-            # Note: the EnSight embedded interpreter will not have these
-            import omni.client  # noqa: F401
-        except ImportError:
-            raise RuntimeError("The module requires the omni module to be installed.") from None
 
-        try:
-            # if we can import pxr, then we can just use sys.executable
-            from pxr import Gf, Sdf, Usd, UsdGeom, UsdLux, UsdShade  # noqa: F401
-
-            if os.path.basename(sys.executable).startswith("kit"):
-                # we are running inside of an Omniverse app like Create, use the 'kit' script
-                raise ImportError("Internal retry")
-
-            self._interpreter = [sys.executable]
+        kit_exe = self.find_kit_filename()
+        if kit_exe:
+            self._interpreter = kit_exe
             return
-        except ImportError:
-            # Can we find 'kit.bat' or 'kit.sh' (we may be running in it)?
-            # Interesting cases:  something/kit/python/python.exe,
-            # something/kit/kit.exe.  All mapped to something/kit.{bat,sh} if found.
-            ov_dir = os.path.dirname(sys.executable)
-            for _ in range(3):
-                for name in ("kit.bat", "kit.sh"):
-                    exe_name = os.path.join(ov_dir, name)
-                    if os.path.exists(exe_name):
-                        self._interpreter = [
-                            exe_name,
-                            "--enable",
-                            "omni.client",
-                            "--enable",
-                            "omni.usd",
-                            "--exec",
-                        ]
-                        return
-                ov_dir = os.path.dirname(ov_dir)
-            raise RuntimeError("Unable to detect a copy of the Omniverse kit executable.") from None
-
-    def _is_running_omniverse(self) -> bool:
+        raise RuntimeError("Unable to detect a copy of the Omniverse kit executable.") from None
+
+    def is_running_omniverse(self) -> bool:
         """Check that an Omniverse connection is active
+
         Returns
         -------
+        bool
             True if the connection is active, False otherwise.
         """
         if self._server_pid is None:
@@ -121,8 +170,10 @@ class Omniverse:
         omniverse_path: str,
         include_camera: bool = False,
         normalize_geometry: bool = False,
+        temporal: bool = False,
         live: bool = True,
         debug_filename: str = "",
+        options: dict = {},
     ) -> None:
         """Ensure that an EnSight dsg -> omniverse server is running
 
@@ -143,6 +194,8 @@ class Omniverse:
             Omniverse units are in meters.  If the source dataset is not in the correct
             unit system or is just too large/small, this option will remap the geometry
             to a unit cube.  Defaults to False.
+        temporal : bool
+            If True, save all timesteps.
         live : bool
             If True, one can call 'update()' to send updated geometry to Omniverse.
             If False, the Omniverse connection will push a single update and then
@@ -150,53 +203,46 @@ class Omniverse:
         debug_filename : str
             If the name of a file is provided, it will be used to save logging information on
             the connection between EnSight and Omniverse.
-
+        options : dict
+            Allows for a fallback for the grpc host/port and the security token.
         """
         if not isinstance(self._ensight, ModuleType):
             self._ensight._session.ensight_version_check("2023 R2")
         self._check_modules()
-        if self._is_running_omniverse():
+        if self.is_running_omniverse():
             raise RuntimeError("An Omniverse server connection is already active.")
-        # Make sure the internal ui module is loaded
-        self._ensight._session.cmd("import enspyqtgui_int", do_eval=False)
-        # Get the gRPC connection details and use them to launch the service
-        port = self._ensight._session.grpc.port()
-        hostname = self._ensight._session.grpc.host
-        token = self._ensight._session.grpc.security_token
-        script_name = "omniverse_dsg_server.py"
-        working_dir = os.path.dirname(__file__)
-        cmd = [
-            script_name,
-            "--host",
-            hostname,
-            "--port",
-            str(port),
-            "--path",
-            omniverse_path,
-        ]
-        if live:
-            cmd.extend(["--live"])
-        if include_camera:
-            cmd.extend(["--vrmode"])
+        if not isinstance(self._ensight, ModuleType):
+            # Make sure the internal ui module is loaded
+            self._ensight._session.cmd("import enspyqtgui_int", do_eval=False)
+            # Get the gRPC connection details and use them to launch the service
+            port = self._ensight._session.grpc.port()
+            hostname = self._ensight._session.grpc.host
+            token = self._ensight._session.grpc.security_token
+        else:
+            hostname = options.get("host", "127.0.0.1")
+            port = options.get("port", 12345)
+            token = options.get("security", "")
+
+        # Launch the server via the 'ansys.geometry.service' kit
+        dsg_uri = f"grpc://{hostname}:{port}"
+        kit_dir = os.path.join(os.path.dirname(ansys.pyensight.core.__file__), "exts")
+        cmd = [self._interpreter]
+        cmd.extend(["--ext-folder", kit_dir])
+        cmd.extend(["--enable", "ansys.geometry.service"])
         if token:
-            cmd.extend(["--security", token])
-        # if temporal:
-        #     cmd.extend(["--animation"])
-        # else:
-        #     cmd.extend(["--no-animation"])
-        if debug_filename:
-            cmd.extend(["--log_file", debug_filename])
-            cmd.extend(["--verbose", "1"])
+            cmd.append(f"--/exts/ansys.geometry.service/securityCode={token}")
+        if temporal:
+            cmd.append("--/exts/ansys.geometry.service/temporal=1")
+        if not include_camera:
+            cmd.append("--/exts/ansys.geometry.service/vrmode=1")
         if normalize_geometry:
-            cmd.extend(["--normalize_geometry"])
-        # if using kit.bat, convert args into a string, otherwise, just use them
-        cmdline = []
-        cmdline.extend(self._interpreter)
-        if len(self._interpreter) > 1:
-            cmd = [" ".join(cmd)]
-        cmdline.extend(cmd)
+            cmd.append("--/exts/ansys.geometry.service/normalizeGeometry=1")
+        cmd.append(f"--/exts/ansys.geometry.service/omniUrl={omniverse_path}")
+        cmd.append(f"--/exts/ansys.geometry.service/dsgUrl={dsg_uri}")
+        cmd.append("--/exts/ansys.geometry.service/run=1")
         env_vars = os.environ.copy()
-        process = subprocess.Popen(cmdline, close_fds=True, env=env_vars, cwd=working_dir)
+        working_dir = os.path.join(os.path.dirname(ansys.pyensight.core.__file__), "utils")
+        process = subprocess.Popen(cmd, close_fds=True, env=env_vars, cwd=working_dir)
         self._server_pid = process.pid
 
     def close_connection(self) -> None:
@@ -206,7 +252,7 @@ class Omniverse:
 
         """
         self._check_modules()
-        if not self._is_running_omniverse():
+        if not self.is_running_omniverse():
             return
         proc = psutil.Process(self._server_pid)
         for child in proc.children(recursive=True):
@@ -223,17 +269,27 @@ class Omniverse:
             pass
         self._server_pid = None
 
-    def update(self) -> None:
+    def update(self, temporal: bool = False) -> None:
         """Update the geometry in Omniverse
 
-        Push the current EnSight scene to the current Omniverse connection.
+        Export the current EnSight scene to the current Omniverse connection.
 
+        Parameters
+        ----------
+        temporal : bool
+            If True, export all timesteps.
         """
-        if not isinstance(self._ensight, ModuleType):
-            self._ensight._session.ensight_version_check("2023 R2")
+        update_cmd = "dynamicscenegraph://localhost/client/update"
+        if temporal:
+            update_cmd += "?timesteps=1"
         self._check_modules()
-        if not self._is_running_omniverse():
+        if not self.is_running_omniverse():
             raise RuntimeError("No Omniverse server connection is currently active.")
-        update_cmd = "dynamicscenegraph://localhost/client/update"
-        cmd = f'enspyqtgui_int.dynamic_scene_graph_command("{update_cmd}")'
-        self._ensight._session.cmd(cmd, do_eval=False)
+        if not isinstance(self._ensight, ModuleType):
+            self._ensight._session.ensight_version_check("2023 R2")
+            cmd = f'enspyqtgui_int.dynamic_scene_graph_command("{update_cmd}")'
+            self._ensight._session.cmd(cmd, do_eval=False)
+        else:
+            import enspyqtgui_int
+
+            enspyqtgui_int.dynamic_scene_graph_command(f"{update_cmd}")