ansys-pyensight-core 0.8.9__py3-none-any.whl → 0.8.11__py3-none-any.whl

ansys/pyensight/core/locallauncher.py

@@ -12,6 +12,7 @@ import glob
 import logging
 import os.path
 import platform
+import re
 import shutil
 import subprocess
 import tempfile
@@ -20,6 +21,7 @@ from typing import Optional
 import uuid
 
 import ansys.pyensight.core as pyensight
+from ansys.pyensight.core.common import find_unused_ports
 from ansys.pyensight.core.launcher import Launcher
 import ansys.pyensight.core.session
 
@@ -89,6 +91,7 @@ class LocalLauncher(Launcher):
         # launched process ids
         self._ensight_pid = None
         self._websocketserver_pid = None
+        self._webui_pid = None
         # and ports
         self._ports = None
         # Are we running the instance in batch
@@ -99,6 +102,36 @@ class LocalLauncher(Launcher):
         """Type of app to launch. Options are ``ensight`` and ``envision``."""
         return self._application
 
+    def launch_webui(self, cpython, webui_script, popen_common):
+        cmd = [cpython]
+        cmd += [webui_script]
+        version = re.findall(r"nexus(\d+)", webui_script)[0]
+        path_to_webui = self._install_path
+        path_to_webui = os.path.join(
+            path_to_webui, f"nexus{version}", f"ansys{version}", "ensight", "WebUI", "web", "ui"
+        )
+        cmd += ["--server-listen-port", str(self._ports[5])]
+        cmd += ["--server-web-roots", path_to_webui]
+        cmd += ["--ensight-grpc-port", str(self._ports[0])]
+        cmd += ["--ensight-html-port", str(self._ports[2])]
+        cmd += ["--ensight-ws-port", str(self._ports[3])]
+        cmd += ["--ensight-session-directory", self._session_directory]
+        cmd += ["--ensight-secret-key", self._secret_key]
+        if "PYENSIGHT_DEBUG" in os.environ:
+            try:
+                if int(os.environ["PYENSIGHT_DEBUG"]) > 0:
+                    del popen_common["stdout"]
+                    del popen_common["stderr"]
+            except (ValueError, KeyError):
+                pass
+        popen_common["env"].update(
+            {
+                "SIMBA_WEBSERVER_TOKEN": self._secret_key,
+                "FLUENT_WEBSERVER_TOKEN": self._secret_key,
+            }
+        )
+        self._webui_pid = subprocess.Popen(cmd, **popen_common).pid
+
     def start(self) -> "pyensight.Session":
         """Start an EnSight session using the local EnSight installation.
 
@@ -126,7 +159,10 @@ class LocalLauncher(Launcher):
 
             # gRPC port, VNC port, websocketserver ws, websocketserver html
             to_avoid = self._find_ports_used_by_other_pyensight_and_ensight()
-            self._ports = self._find_unused_ports(5, avoid=to_avoid)
+            num_ports = 5
+            if self._launch_webui:
+                num_ports = 6
+            self._ports = find_unused_ports(num_ports, avoid=to_avoid)
             if self._ports is None:
                 raise RuntimeError("Unable to allocate local ports for EnSight session")
             is_windows = self._is_windows()
@@ -211,11 +247,12 @@ class LocalLauncher(Launcher):
             except Exception:
                 pass
             websocket_script = found_scripts[idx]
-
+            webui_script = websocket_script.replace("websocketserver.py", "webui_launcher.py")
             # build the commandline
             cmd = [os.path.join(self._install_path, "bin", "cpython"), websocket_script]
             if is_windows:
                 cmd[0] += ".bat"
+            ensight_python = cmd[0]
             cmd.extend(["--http_directory", self.session_directory])
             # http port
             cmd.extend(["--http_port", str(self._ports[2])])
@@ -256,9 +293,13 @@ class LocalLauncher(Launcher):
             timeout=self._timeout,
             sos=use_sos,
             rest_api=self._enable_rest_api,
+            webui_port=self._ports[5] if self._launch_webui else None,
         )
         session.launcher = self
         self._sessions.append(session)
+
+        if self._launch_webui:
+            self.launch_webui(ensight_python, webui_script, popen_common)
         return session
 
     def stop(self) -> None:

ansys/pyensight/core/renderable.py

@@ -3,10 +3,12 @@
 This module provides the interface for creating objects in the EnSight session
 that can be displayed via HTML over the websocket server interface.
 """
+import hashlib
 import os
 import shutil
 from typing import TYPE_CHECKING, Any, Dict, List, Optional, Tuple, Union, no_type_check
 import uuid
+import warnings
 import webbrowser
 
 import requests
@@ -812,3 +814,31 @@ class RenderableSGEO(Renderable):  # pragma: no cover
         html = html.replace("REVURL_ITEMID", revision_uri)
         html = html.replace("ITEMID", self._guid)
         return html
+
+
+class RenderableFluidsWebUI(Renderable):
+    def __init__(self, *args, **kwargs) -> None:
+        super().__init__(*args, **kwargs)
+        self._session.ensight_version_check("2025 R1")
+        warnings.warn("The webUI is still under active development and should be considered beta.")
+        self._rendertype = "webui"
+        self._generate_url()
+        self.update()
+
+    def _generate_url(self) -> None:
+        sha256_hash = hashlib.sha256()
+        sha256_hash.update(self._session._secret_key.encode())
+        token = sha256_hash.hexdigest()
+        optional_query = self._get_query_parameters_str()
+        port = self._session._webui_port
+        if "instance_name" in self._session._launcher._get_query_parameters():
+            instance_name = self._session._launcher._get_query_parameters()["instance_name"]
+            # If using PIM, the port needs to be the 443 HTTPS Port;
+            port = self._session.html_port
+            # In the webUI code there's already a workflow to pass down the query parameter
+            # ans_instance_id, just use it
+            instance_name = self._session._launcher._get_query_parameters()["instance_name"]
+            optional_query = f"?ans_instance_id={instance_name}"
+        url = f"{self._http_protocol}://{self._session.html_hostname}:{port}"
+        url += f"{optional_query}#{token}"
+        self._url = url

ansys/pyensight/core/session.py

@@ -31,6 +31,7 @@ from ansys.pyensight.core.listobj import ensobjlist
 from ansys.pyensight.core.renderable import (
     RenderableDeepPixel,
     RenderableEVSN,
+    RenderableFluidsWebUI,
     RenderableImage,
     RenderableMP4,
     RenderableSGEO,
@@ -136,6 +137,7 @@ class Session:
         timeout: float = 120.0,
         rest_api: bool = False,
         sos: bool = False,
+        webui_port: Optional[int] = None,
     ) -> None:
         # every session instance needs a unique name that can be used as a cache key
         self._session_name = str(uuid.uuid1())
@@ -161,6 +163,7 @@ class Session:
         self._grpc_port = grpc_port
         self._halt_ensight_on_close = True
         self._callbacks: Dict[str, Tuple[int, Any]] = dict()
+        self._webui_port = webui_port
         # if the caller passed a session directory we will assume they are
         # creating effectively a proxy Session and create a (stub) launcher
         if session_directory is not None:
@@ -927,6 +930,8 @@ class Session:
         # Undocumented. Available only internally
         elif what == "webensight":
             render = RenderableVNCAngular(self, **kwargs)
+        elif what == "webui":
+            render = RenderableFluidsWebUI(self, **kwargs)
 
         if render is None:
             raise RuntimeError("Unable to generate requested visualization")

ansys/pyensight/core/utils/omniverse.py

@@ -44,7 +44,7 @@ class Omniverse:
     >>> from ansys.pyensight.core import LocalLauncher
     >>> session = LocalLauncher().start()
     >>> ov = session.ensight.utils.omniverse
-    >>> ov.create_connection()
+    >>> ov.create_connection(r"D:\Omniverse\Example")
     >>> ov.update()
     >>> ov.close_connection()
 
@@ -202,8 +202,8 @@ class Omniverse:
         Parameters
         ----------
         omniverse_path : str
-            The URI to the Omniverse server. It will look like this:
-            "omniverse://localhost/Users/test"
+            The directory name where the USD files should be saved. For example:
+            "C:/Users/test/OV/usdfiles"
         include_camera : bool
             If True, apply the EnSight camera to the Omniverse scene.  This option
             should be used if the target viewer is in AR/VR mode.  Defaults to False.

ansys/pyensight/core/utils/readers.py

@@ -10,8 +10,6 @@ from types import ModuleType
 from typing import Optional, Tuple, Union
 import uuid
 
-from ansys.pyensight.core import LocalLauncher
-
 try:
     import ensight
 except ImportError:
@@ -27,6 +25,7 @@ class Readers:
 
     @property
     def dvs(self) -> "DVS":
+        """The ensight interface"""
         return self._dvs
 
 
@@ -104,15 +103,20 @@ class DVS:
         """Find the dvs port allocated from the input temporary name"""
         if not tmp_name:
             raise RuntimeError("Temporary name for dvs port file not available")
-        is_local = isinstance(self._ensight._session._launcher, LocalLauncher)
-        if is_local:
-            with open(tmp_name) as dvs_port_file:
-                self._dvs_port = int(dvs_port_file.read().strip())
-        else:
-            log_content = self._ensight._session._launcher.enshell_log_contents()
-            dvs_port_match = re.search(r"\(0.0.0.0\):([0-9]{4,5})\n", log_content)
-            if dvs_port_match:
-                self._dvs_port = int(str(dvs_port_match.groups(1)[0]).strip())
+        try_local = True
+        if self._ensight._session._launcher:
+            if hasattr(self._ensight._session._launcher, "_enshell"):
+                try_local = False
+                log_content = self._ensight._session._launcher.enshell_log_contents()
+                dvs_port_match = re.search(r"\(0.0.0.0\):([0-9]{4,5})\n", log_content)
+                if dvs_port_match:
+                    self._dvs_port = int(str(dvs_port_match.groups(1)[0]).strip())
+        if try_local:
+            try:
+                with open(tmp_name) as dvs_port_file:
+                    self._dvs_port = int(dvs_port_file.read().strip())
+            except Exception:
+                raise RuntimeError("Cannot retrieve DVS Port")
 
     @staticmethod
     def _launch_dvs_callback_in_ensight(

{ansys_pyensight_core-0.8.9.dist-info → ansys_pyensight_core-0.8.11.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: ansys-pyensight-core
-Version: 0.8.9
+Version: 0.8.11
 Summary: A python wrapper for Ansys EnSight
 Author-email: "ANSYS, Inc." <pyansys.core@ansys.com>
 Maintainer-email: "ANSYS, Inc." <pyansys.core@ansys.com>
@@ -16,7 +16,7 @@ Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Requires-Dist: importlib-metadata>=4.0; python_version<='3.8'
-Requires-Dist: ansys-api-pyensight==0.4.1
+Requires-Dist: ansys-api-pyensight==0.4.2
 Requires-Dist: requests>=2.28.2
 Requires-Dist: docker>=6.1.0
 Requires-Dist: urllib3<3.0.0
@@ -24,13 +24,13 @@ Requires-Dist: numpy>=1.21.0,<2
 Requires-Dist: Pillow>=9.3.0
 Requires-Dist: pypng>=0.0.20
 Requires-Dist: psutil>=5.9.2
+Requires-Dist: usd-core>=24.8
+Requires-Dist: pygltflib>=1.16.2
 Requires-Dist: build>=0.10.0 ; extra == "dev"
 Requires-Dist: bump2version>=1.0.1 ; extra == "dev"
 Requires-Dist: ipdb>=0.9.4 ; extra == "dev"
 Requires-Dist: dill>=0.3.5.1 ; extra == "dev"
 Requires-Dist: pre-commit>=3.3.3 ; extra == "dev"
-Requires-Dist: usd-core>=24.8 ; extra == "dev"
-Requires-Dist: pygltflib>=1.16.2 ; extra == "dev"
 Requires-Dist: Sphinx==8.0.2 ; extra == "doc"
 Requires-Dist: numpydoc==1.5.0 ; extra == "doc"
 Requires-Dist: ansys-sphinx-theme==0.9.9 ; extra == "doc"
@@ -53,8 +53,6 @@ Requires-Dist: pytest-mock==3.10.0 ; extra == "tests"
 Requires-Dist: urllib3==2.2.2 ; extra == "tests"
 Requires-Dist: requests>=2.28.2 ; extra == "tests"
 Requires-Dist: docker>=6.1.0 ; extra == "tests"
-Requires-Dist: usd-core>=24.8 ; extra == "tests"
-Requires-Dist: pygltflib>=1.16.2 ; extra == "tests"
 Project-URL: Changelog, https://github.com/ansys/pyensight/blob/main/CHANGELOG.rst
 Project-URL: Documentation, https://ensight.docs.pyansys.com/
 Project-URL: Homepage, https://github.com/ansys/pyensight

{ansys_pyensight_core-0.8.9.dist-info → ansys_pyensight_core-0.8.11.dist-info}/RECORD

@@ -1,34 +1,36 @@
-ansys/pyensight/core/__init__.py,sha256=6iKVEEtxt-6mw7wu_AocOGYO1T1WYHAnk-X_jeTeA8k,828
+ansys/pyensight/core/__init__.py,sha256=yF8ER4bnq8oPCdC1iyO-0Po8zg1hnmkXIooOtyz2INQ,845
+ansys/pyensight/core/common.py,sha256=BgnRfE5NltIjVkI96U98zWv_u4QcLyeMetD59LKVAI4,7086
 ansys/pyensight/core/deep_pixel_view.html,sha256=oZmcCIS3Dqqsoj8oheYubLAH2ZVKXao3iJM2WXYBEKs,3421
-ansys/pyensight/core/dockerlauncher.py,sha256=AEuBA24hdWn82vPSyBkx66OyEHeIyozICWeF_zDx-yA,28540
+ansys/pyensight/core/dockerlauncher.py,sha256=LmgEFEjl0l3D_JaeJu5bbGR28aluHYtzb0-BmrC7ta8,28251
 ansys/pyensight/core/enscontext.py,sha256=GSKkjZt1QEPyHEQ59EEBgKGMik9vjCdR9coR4uX7fEw,12141
-ansys/pyensight/core/enshell_grpc.py,sha256=ijRcByqdG0ZIi958Co860w2mnBIklfguI6s8sewcR8Q,15904
+ansys/pyensight/core/enshell_grpc.py,sha256=-OxSdFI_p3DmQnqh1jT_a_aSh_w-EUD2IaWGKxrnyjI,17122
 ansys/pyensight/core/ensight_grpc.py,sha256=BJaErleSPrtI8myTIh0m9awFWPaUxrQmHpbuyR3RpM4,16847
 ansys/pyensight/core/ensobj.py,sha256=uDtM2KHcAwd4hu5pcUYWbSD729ApHGIvuqZhEq8PxTI,18558
-ansys/pyensight/core/launch_ensight.py,sha256=UyTDDmxru864YAihTY9EQ5NIbKFRiLpWGPHMu7JUgyY,6175
-ansys/pyensight/core/launcher.py,sha256=J9yZnP3ygfGmw26hCYS_H1zk_YI_IE6QS8ItWJ80vwU,12659
+ansys/pyensight/core/launch_ensight.py,sha256=iZJM6GdpzGRDLzrv1V2QZ5veIOpNSB5xPpJUFY7rBuo,10254
+ansys/pyensight/core/launcher.py,sha256=ymwfixwoHO7_c4qOetqccQbZjGT1HjeA7jwPi2JxlmE,10585
+ansys/pyensight/core/libuserd.py,sha256=P5ewBFey_a9YYhRhbWSCCy2KXtyccsJyyLWlYh-Hxgo,72592
 ansys/pyensight/core/listobj.py,sha256=Trw87IxIMXtmUd1DzywRmMzORU704AG4scX4fqYmO6M,9340
-ansys/pyensight/core/locallauncher.py,sha256=s70b7sYurRy1VD5ZI2JFVhruX3bmxCOTp7_YWQXoZs8,14376
+ansys/pyensight/core/locallauncher.py,sha256=MnSyKVe0JGXN0YJ9f_msw_TBbLGfqDpjWWC4-haAjJ4,16205
 ansys/pyensight/core/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-ansys/pyensight/core/renderable.py,sha256=hm4sXV-ZcpdfC_AJexycAX8zdsbWnsd-tMeUvewGekE,35003
-ansys/pyensight/core/session.py,sha256=W7sSuZEK648va69lE6EiiOqd_h9YRwgRXihZoNB9V78,74386
+ansys/pyensight/core/renderable.py,sha256=Z59F0u1Znot_MU_fT77F4CO7qbDxqDetFGzzgZcekCs,36440
+ansys/pyensight/core/session.py,sha256=jQA1sT7N3Q4iATH0vtzKf3v6ghg461LphZ2nUeyufCU,74587
 ansys/pyensight/core/sgeo_poll.html,sha256=1M4BIc5CZpYA3b40qzk22NcPCLhjFnWdoS2PrS6Rhn4,752
 ansys/pyensight/core/utils/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 ansys/pyensight/core/utils/adr.py,sha256=XslZhlwcrSGzOlnhzprOv3ju_ppxxsWBjCnQL5KiNms,3570
 ansys/pyensight/core/utils/dsg_server.py,sha256=zPvIHlgiJxiy0NQm3uIsh2nPY8TyAHaHaXtDMN28jiY,38869
 ansys/pyensight/core/utils/export.py,sha256=ZNpU3earAnRMBHZa6I8nTwMYY54WctXApJfMTkREBNA,23189
-ansys/pyensight/core/utils/omniverse.py,sha256=GWTYQhhVMT9x4kpMPpI51mHNiV1ths2zk8YzBZ2eeD0,14222
+ansys/pyensight/core/utils/omniverse.py,sha256=k3SxbK_BDmwbiUPr9PLKEswZAyri6EEiT_gaMWIu6zw,14250
 ansys/pyensight/core/utils/omniverse_cli.py,sha256=aePr-2AWla2mMgPx8NlwIApAD1rAdVLmNOBWKjMXNQA,18786
 ansys/pyensight/core/utils/omniverse_dsg_server.py,sha256=SjKY8-q-M26tge13HW6Js71RoQnFgkjWELtHpXk707c,28185
 ansys/pyensight/core/utils/omniverse_glb_server.py,sha256=VYSbIwKMZASAmgYwRGbN5PrCjbSdaL7MaFxMnOJlTFg,9793
 ansys/pyensight/core/utils/parts.py,sha256=zST00r76kjsLLclBaKoOtuYhDUSdQr0vAooOG7AUea0,53372
 ansys/pyensight/core/utils/query.py,sha256=OXKDbf1sOTX0sUvtKcp64LhVl-BcrEsE43w8uMxLOYI,19828
-ansys/pyensight/core/utils/readers.py,sha256=WUpmCtMo9BHlUOwGtIrD5jjyS9HE9wDak8eEjrYeR2Y,11764
+ansys/pyensight/core/utils/readers.py,sha256=cNNzrE5pjy4wpQKWAzIIJfJCSpY3HU43az02f5I3pVU,11968
 ansys/pyensight/core/utils/support.py,sha256=QI3z9ex7zJxjFbkCPba9DWqWgPFIThORqr0nvRfVjuc,4089
 ansys/pyensight/core/utils/variables.py,sha256=T96aL-qR2FtxH6QafeD9ddcWL9BB6IRSOYs2JauRTlg,95133
 ansys/pyensight/core/utils/views.py,sha256=ZKhJ6vMT7Rdd4bwJ0egMYTV7-D7Q7I19fF2_j_CMQ0o,12489
 ansys/pyensight/core/utils/resources/Materials/000_sky.exr,sha256=xAR1gFd2uxPZDnvgfegdhEhRaqKtZldQDiR_-1rHKO0,8819933
-ansys_pyensight_core-0.8.9.dist-info/LICENSE,sha256=qQWivZ12ETN5l3QxvTARY-QI5eoRRlyHdwLlAj0Bg5I,1089
-ansys_pyensight_core-0.8.9.dist-info/WHEEL,sha256=EZbGkh7Ie4PoZfRQ8I0ZuP9VklN_TvcZ6DSE5Uar4z4,81
-ansys_pyensight_core-0.8.9.dist-info/METADATA,sha256=Tvyi5fhWgWo09nNEPF99-_iSKrHtNHkj6AlAbGcA19A,12133
-ansys_pyensight_core-0.8.9.dist-info/RECORD,,
+ansys_pyensight_core-0.8.11.dist-info/LICENSE,sha256=qQWivZ12ETN5l3QxvTARY-QI5eoRRlyHdwLlAj0Bg5I,1089
+ansys_pyensight_core-0.8.11.dist-info/WHEEL,sha256=EZbGkh7Ie4PoZfRQ8I0ZuP9VklN_TvcZ6DSE5Uar4z4,81
+ansys_pyensight_core-0.8.11.dist-info/METADATA,sha256=7HoVAVfhnAucYeDmIIrcRhCXjcObDnISxnMQHENPKgM,11999
+ansys_pyensight_core-0.8.11.dist-info/RECORD,,