ansys-pyensight-core 0.7.7__tar.gz → 0.7.8__tar.gz

{ansys_pyensight_core-0.7.7 → ansys_pyensight_core-0.7.8}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: ansys-pyensight-core
-Version: 0.7.7
+Version: 0.7.8
 Summary: A python wrapper for Ansys EnSight
 Author-email: "ANSYS, Inc." <pyansys.core@ansys.com>
 Maintainer-email: "ANSYS, Inc." <pyansys.core@ansys.com>

{ansys_pyensight_core-0.7.7 → ansys_pyensight_core-0.7.8}/pyproject.toml

@@ -6,7 +6,7 @@ build-backend = "flit_core.buildapi"
 
 [project]
 name = "ansys-pyensight-core"
-version = "0.7.7"
+version = "0.7.8"
 description = "A python wrapper for Ansys EnSight"
 readme = "README.rst"
 requires-python = ">=3.9,<4"

{ansys_pyensight_core-0.7.7 → ansys_pyensight_core-0.7.8}/src/ansys/pyensight/core/renderable.py

@@ -540,6 +540,20 @@ class RenderableVNC(Renderable):
         self._rendertype = "remote"
         self.update()
 
+    def _update_2023R2_or_less(self):
+        """Update the remote rendering widget and display it for
+        backend EnSight of version earlier than 2024R1
+        """
+        query_params = {
+            "autoconnect": "true",
+            "host": self._session.html_hostname,
+            "port": self._session.ws_port,
+        }
+        url = f"{self._http_protocol}://{self._session.html_hostname}:{self._session.html_port}"
+        url += "/ansys/nexus/novnc/vnc_envision.html"
+        url += self._get_query_parameters_str(query_params)
+        self._url = url
+
     def update(self):
         """Update the remote rendering widget and display it.
 
@@ -549,29 +563,36 @@ class RenderableVNC(Renderable):
         """
         optional_query = self._get_query_parameters_str()
         version = _get_ansysnexus_version(self._session._cei_suffix)
-        html = f"<script src='/ansys{version}/nexus/viewer-loader.js{optional_query}'></script>\n"
-        rest_uri = (
-            f"{self._http_protocol}://{self._session.html_hostname}:{self._session.html_port}"
-        )
-        ws_uri = f"{self._http_protocol}://{self._session.html_hostname}:{self._session.ws_port}"
-
-        query_args = ""
-        if self._using_proxy and optional_query:
-            query_args = f', "extra_query_args":"{optional_query[1:]}"'
-
-        attributes = ' renderer="envnc"'
-        attributes += ' ui="simple"'
-        attributes += ' active="true"'
-        attributes += (
-            " renderer_options='"
-            + f'{{ "ws":"{ws_uri}", "http":"{rest_uri}", "security_token":"{self._session.secret_key}", "connect_to_running_ens":true {query_args} }}'
-            + "'"
-        )
+        if int(self._session._cei_suffix) < 241:
+            self._update_2023R2_or_less()
+        else:
+            html = (
+                f"<script src='/ansys{version}/nexus/viewer-loader.js{optional_query}'></script>\n"
+            )
+            rest_uri = (
+                f"{self._http_protocol}://{self._session.html_hostname}:{self._session.html_port}"
+            )
+            ws_uri = (
+                f"{self._http_protocol}://{self._session.html_hostname}:{self._session.ws_port}"
+            )
 
-        html += f"<ansys-nexus-viewer {attributes}></ansys-nexus-viewer>\n"
+            query_args = ""
+            if self._using_proxy and optional_query:
+                query_args = f', "extra_query_args":"{optional_query[1:]}"'
+
+            attributes = ' renderer="envnc"'
+            attributes += ' ui="simple"'
+            attributes += ' active="true"'
+            attributes += (
+                " renderer_options='"
+                + f'{{ "ws":"{ws_uri}", "http":"{rest_uri}", "security_token":"{self._session.secret_key}", "connect_to_running_ens":true {query_args} }}'
+                + "'"
+            )
 
-        # refresh the remote HTML
-        self._save_remote_html_page(html)
+            html += f"<ansys-nexus-viewer {attributes}></ansys-nexus-viewer>\n"
+
+            # refresh the remote HTML
+            self._save_remote_html_page(html)
         super().update()
 
 

{ansys_pyensight_core-0.7.7 → ansys_pyensight_core-0.7.8}/src/ansys/pyensight/core/utils/omniverse.py

@@ -2,7 +2,7 @@ import os
 import subprocess
 import sys
 from types import ModuleType
-from typing import TYPE_CHECKING, Optional, Union
+from typing import TYPE_CHECKING, List, Optional, Union
 
 import psutil
 
@@ -17,7 +17,7 @@ class Omniverse:
     """Provides the ``ensight.utils.omniverse`` interface.
 
     The omniverse class methods provide an interface between an EnSight session
-    and an Omniverse instance.
+    and an Omniverse instance.  See :ref:`omniverse_info` for additional details.
 
     Note
     ----
@@ -48,26 +48,60 @@ class Omniverse:
     def __init__(self, interface: Union["ensight_api.ensight", "ensight"]):
         self._ensight = interface
         self._server_pid: Optional[int] = None
+        self._interpreter: List[str] = []
 
-    @staticmethod
-    def _check_modules() -> None:
+    def _check_modules(self) -> None:
         """Verify that the Python interpreter is correct
 
-        Check for omni and pxr modules. If not present, raise an exception.
+        Check for omni module. If not present, raise an exception.
+        If pxr is there as well, then we can just use sys.executable.
+        If not, check to see if 'kit.bat' or 'kit.sh' can be found and
+        arrange to use those instead.
 
         Raises
         ------
         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  # noqa: F401
-            import pxr  # noqa: F401
+            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]
+            return
         except ImportError:
-            raise RuntimeError(
-                "The module requires the omni and pxr modules to be installed."
-            ) from None
+            # 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:
         """Check that an Omniverse connection is active
@@ -88,7 +122,6 @@ class Omniverse:
         include_camera: bool = False,
         normalize_geometry: bool = False,
         live: bool = True,
-        temporal: bool = False,
         debug_filename: str = "",
     ) -> None:
         """Ensure that an EnSight dsg -> omniverse server is running
@@ -103,21 +136,18 @@ class Omniverse:
         omniverse_path : str
             The URI to the Omniverse server. It will look like this:
             "omniverse://localhost/Users/test"
-        include_camera: bool
+        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.
-        normalize_geometry: bool
+        normalize_geometry : bool
             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.
-        live: bool
+        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
             disconnect.  Defaults to True.
-        temporal: bool
-            If True, all EnSight timesteps will be pushed to Omniverse.  Defaults to False, only
-            the current timestep is pushed.
-        debug_filename: str
+        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.
 
@@ -136,7 +166,6 @@ class Omniverse:
         script_name = "omniverse_dsg_server.py"
         working_dir = os.path.dirname(__file__)
         cmd = [
-            sys.executable,
             script_name,
             "--host",
             hostname,
@@ -151,17 +180,23 @@ class Omniverse:
             cmd.extend(["--vrmode"])
         if token:
             cmd.extend(["--security", token])
-        if temporal:
-            cmd.extend(["--animation"])
-        else:
-            cmd.extend(["--no-animation"])
+        # if temporal:
+        #     cmd.extend(["--animation"])
+        # else:
+        #     cmd.extend(["--no-animation"])
         if debug_filename:
             cmd.extend(["--log_file", debug_filename])
             cmd.extend(["--verbose", "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)
         env_vars = os.environ.copy()
-        process = subprocess.Popen(cmd, close_fds=True, env=env_vars, cwd=working_dir)
+        process = subprocess.Popen(cmdline, close_fds=True, env=env_vars, cwd=working_dir)
         self._server_pid = process.pid
 
     def close_connection(self) -> None:

{ansys_pyensight_core-0.7.7 → ansys_pyensight_core-0.7.8}/src/ansys/pyensight/core/utils/omniverse_dsg_server.py

@@ -63,6 +63,8 @@ class OmniverseWrapper:
         path: str = "omniverse://localhost/Users/test",
         verbose: int = 0,
     ):
+        self._cleaned_index = 0
+        self._cleaned_names: dict = {}
         self._connectionStatusSubscription = None
         self._stage = None
         self._destinationPath = path
@@ -299,17 +301,51 @@ class OmniverseWrapper:
         self.save_stage()
         return boxPrim
 
-    @staticmethod
-    def clean_name(name: str, id_name: Any = None) -> str:
-        name = name.replace(" ", "_").replace("-", "_")
+    def clear_cleaned_names(self) -> None:
+        """Clear the list of cleaned names"""
+        self._cleaned_names = {}
+        self._cleaned_index = 0
+
+    def clean_name(self, name: str, id_name: Any = None) -> str:
+        """Generate a vais USD name
+
+        From a base (EnSight) varname, partname, etc. and the DSG id, generate
+        a unique, valid USD name.  Save the names so that if the same name
+        comes in again, the previously computed name is returned and if the
+        manipulation results in a conflict, the name can be made unique.
+
+        Parameters
+        ----------
+        name:
+            The name to generate a USD name for.
+
+        id_name:
+            The DSG id associated with the DSG name, if any.
+
+        Returns
+        -------
+            A unique USD name.
+        """
+        # return any previously generated name
+        if (name, id_name) in self._cleaned_names:
+            return self._cleaned_names[(name, id_name)]
+        # replace invalid characters
+        name = name.replace("+", "_").replace("-", "_")
         name = name.replace(".", "_").replace(":", "_")
         name = name.replace("[", "_").replace("]", "_")
         name = name.replace("(", "_").replace(")", "_")
         name = name.replace("<", "_").replace(">", "_")
         name = name.replace("/", "_").replace("=", "_")
-        name = name.replace(",", "_")
-        if id is not None:
+        name = name.replace(",", "_").replace(" ", "_")
+        if id_name is not None:
             name = name + "_" + str(id_name)
+        if name in self._cleaned_names.values():
+            # Make the name unique
+            while f"{name}_{self._cleaned_index}" in self._cleaned_names.values():
+                self._cleaned_index += 1
+            name = f"{name}_{self._cleaned_index}"
+        # store off the cleaned name
+        self._cleaned_names[(name, id_name)] = name
         return name
 
     @staticmethod
@@ -1011,6 +1047,7 @@ class DSGOmniverseLink(object):
         self._part = Part(self)
         self._scene_bounds = None
         self._mesh_block_count = 0  # reset when a new group shows up
+        self._omni.clear_cleaned_names()
 
         # handle the various commands until UPDATE_SCENE_END
         cmd = self.get_next_message()

{ansys_pyensight_core-0.7.7 → ansys_pyensight_core-0.7.8}/src/ansys/pyensight/core/utils/variables.py

@@ -1266,6 +1266,7 @@ class Variables:
         """
         frames = (
             self.ensight.objs.core.FRAMES is not None
+            and len(self.ensight.objs.core.FRAMES) > 0
             and "frame_index" in params
             and int(params["frame_index"]) > 0
         )
@@ -1460,34 +1461,38 @@ class Variables:
                         # Coefficient shear force components then magnitude
                         #
                         if shear_coeff_list is not None and press_coeff_list is not None:
-                            fp.write(" , ")
-                            for jj in range(3):
-                                fp.write(str(shear_coeff_list[ii][jj]))
+                            if len(shear_coeff_list) > 0 and len(press_coeff_list) > 0:
                                 fp.write(" , ")
-                            fp.write(str(vec_mag(shear_coeff_list[ii][:3])))
-                            fp.write(" , ")
-                            if frames:
                                 for jj in range(3):
-                                    fp.write(str(shear_coeff_list[ii][jj + 3]))
+                                    fp.write(str(shear_coeff_list[ii][jj]))
                                     fp.write(" , ")
-                                fp.write(str(vec_mag(shear_coeff_list[ii][3:])))
-                                fp.write(" , ")
-                            # sum of pressure and shear Coefficient components then magnitude
-                            for jj in range(3):
-                                temp_list[jj] = press_coeff_list[ii][jj] + shear_coeff_list[ii][jj]
-                                fp.write(str(temp_list[jj]))
-                                fp.write(" , ")
-                            fp.write(str(vec_mag(temp_list)))
-                            if frames:
+                                fp.write(str(vec_mag(shear_coeff_list[ii][:3])))
                                 fp.write(" , ")
+                                if frames:
+                                    for jj in range(3):
+                                        fp.write(str(shear_coeff_list[ii][jj + 3]))
+                                        fp.write(" , ")
+                                    fp.write(str(vec_mag(shear_coeff_list[ii][3:])))
+                                    fp.write(" , ")
+                                # sum of pressure and shear Coefficient components then magnitude
                                 for jj in range(3):
                                     temp_list[jj] = (
-                                        press_coeff_list[ii][jj + 3] + shear_coeff_list[ii][jj + 3]
+                                        press_coeff_list[ii][jj] + shear_coeff_list[ii][jj]
                                     )
                                     fp.write(str(temp_list[jj]))
                                     fp.write(" , ")
                                 fp.write(str(vec_mag(temp_list)))
-                            fp.write(" , ")
+                                if frames:
+                                    fp.write(" , ")
+                                    for jj in range(3):
+                                        temp_list[jj] = (
+                                            press_coeff_list[ii][jj + 3]
+                                            + shear_coeff_list[ii][jj + 3]
+                                        )
+                                        fp.write(str(temp_list[jj]))
+                                        fp.write(" , ")
+                                    fp.write(str(vec_mag(temp_list)))
+                                fp.write(" , ")
                         #
                         # Lift, Drag and Side Force
                         # No cylindrical stuff here
@@ -1501,43 +1506,49 @@ class Variables:
                             fp.write(" , ")
                         # LDS shear force components then magnitude
                         if shear_LDS_force_list is not None and press_LDS_force_list is not None:
-                            for jj in range(3):
-                                fp.write(str(shear_LDS_force_list[ii][jj]))
-                                fp.write(" , ")
-                            fp.write(str(vec_mag(shear_LDS_force_list[ii][:3])))
-                            fp.write(" , ")
-                            # LDS sum of pressure and shear forces components then magnitude
-                            for jj in range(3):
-                                temp_list[jj] = (
-                                    press_LDS_force_list[ii][jj] + shear_LDS_force_list[ii][jj]
-                                )
-                                fp.write(str(temp_list[jj]))
-                                fp.write(" , ")
-                            fp.write(str(vec_mag(temp_list)))
-                            fp.write(" , ")
-                        # LDS Coefficient of pressure force components then magnitude
-                        if press_LDS_coeff_list:
-                            for jj in range(3):
-                                fp.write(str(press_LDS_coeff_list[ii][jj]))
+                            if len(shear_LDS_force_list) > 0 and len(press_LDS_force_list) > 0:
+                                for jj in range(3):
+                                    fp.write(str(shear_LDS_force_list[ii][jj]))
+                                    fp.write(" , ")
+                                fp.write(str(vec_mag(shear_LDS_force_list[ii][:3])))
                                 fp.write(" , ")
-                            fp.write(str(vec_mag(press_LDS_coeff_list[ii][:3])))
-                            fp.write(" , ")
-                        # LDS Coefficient shear force components then magnitude
-                        if shear_LDS_coeff_list is not None and press_LDS_coeff_list is not None:
-                            for jj in range(3):
-                                fp.write(str(shear_LDS_coeff_list[ii][jj]))
+                                # LDS sum of pressure and shear forces components then magnitude
+                                for jj in range(3):
+                                    temp_list[jj] = (
+                                        press_LDS_force_list[ii][jj] + shear_LDS_force_list[ii][jj]
+                                    )
+                                    fp.write(str(temp_list[jj]))
+                                    fp.write(" , ")
+                                fp.write(str(vec_mag(temp_list)))
                                 fp.write(" , ")
-                            fp.write(str(vec_mag(shear_LDS_coeff_list[ii][:3])))
-                            fp.write(" , ")
-                            # LDS sum of pressure and shear Coefficient components then magnitude
-                            for jj in range(3):
-                                temp_list[jj] = (
-                                    press_LDS_coeff_list[ii][jj] + shear_LDS_coeff_list[ii][jj]
-                                )
-                                fp.write(str(temp_list[jj]))
+                            # LDS Coefficient of pressure force components then magnitude
+                            if press_LDS_coeff_list:
+                                for jj in range(3):
+                                    fp.write(str(press_LDS_coeff_list[ii][jj]))
+                                    fp.write(" , ")
+                                fp.write(str(vec_mag(press_LDS_coeff_list[ii][:3])))
                                 fp.write(" , ")
-                            fp.write(str(vec_mag(temp_list)))
-                        fp.write("\n")
+                            # LDS Coefficient shear force components then magnitude
+                            if (
+                                shear_LDS_coeff_list is not None
+                                and press_LDS_coeff_list is not None
+                            ):
+                                if len(shear_LDS_coeff_list) > 0 and len(press_LDS_coeff_list) > 0:
+                                    for jj in range(3):
+                                        fp.write(str(shear_LDS_coeff_list[ii][jj]))
+                                        fp.write(" , ")
+                                    fp.write(str(vec_mag(shear_LDS_coeff_list[ii][:3])))
+                                    fp.write(" , ")
+                                    # LDS sum of pressure and shear Coefficient components then magnitude
+                                    for jj in range(3):
+                                        temp_list[jj] = (
+                                            press_LDS_coeff_list[ii][jj]
+                                            + shear_LDS_coeff_list[ii][jj]
+                                        )
+                                        fp.write(str(temp_list[jj]))
+                                        fp.write(" , ")
+                                    fp.write(str(vec_mag(temp_list)))
+                                fp.write("\n")
                     #  FIX ME keep track of and write out totals here when loop is done on last line?
                     fp.close()
                     return True
@@ -1843,61 +1854,62 @@ class Variables:
                             self._lds_forces(np.array(part_force), lift_vec, drag_vec, side_vec)
                         )
         if export_filename is not None and pobj_list is not None:
-            press_varname = None
-            shear_varname = None
-            if press_var_obj:
-                _press_var_id = convert_variable(self.ensight, press_var_obj)
-                if _press_var_id:
-                    press_varnames = [
-                        v for v in self.ensight.objs.core.VARIABLES if v.ID == _press_var_id
-                    ]
-                    if press_varnames:
-                        press_varname = str(press_varnames[0].DESCRIPTION)
-            if shear_var_obj:
-                _shear_var_id = convert_variable(self.ensight, shear_var_obj)
-                if _shear_var_id:
-                    shear_varnames = [
-                        v for v in self.ensight.objs.core.VARIABLES if v.ID == _press_var_id
-                    ]
-                    if shear_varnames:
-                        shear_varname = str(shear_varnames[0].DESCRIPTION)
-            params = {}
-            if press_varname:
-                params["press_varname"] = press_varname
-            if shear_varname:
-                params["shear_varname"] = shear_varname
-            if shear_var_type is not None:
-                value = shear_map.get(shear_var_type)
-                if value:
-                    params["shear_vartype"] = value
-            if area_ref:
-                params["Area_ref"] = str(area_ref)
-            if density_ref:
-                params["Dens_ref"] = str(density_ref)
-            if velocity_x_ref:
-                params["Vx_ref"] = str(velocity_x_ref)
-            if velocity_y_ref:
-                params["Vy_ref"] = str(velocity_y_ref)
-            if velocity_z_ref:
-                params["Vz_ref"] = str(velocity_z_ref)
-            if up_vector:
-                params["up_vector"] = up_vector
-            if frame_index > 0:
-                params["frame_index"] = str(frame_index)
-
-            self._write_out_force_data(
-                export_filename,
-                _pobj_list,
-                params=params,
-                press_force_list=computed_press_forces,
-                shear_force_list=computed_shear_forces,
-                press_coeff_list=computed_press_force_coeffs,
-                shear_coeff_list=computed_shear_force_coeffs,
-                press_LDS_force_list=computed_press_forces_lds,
-                shear_LDS_force_list=computed_shear_forces_lds,
-                press_LDS_coeff_list=computed_press_forces_lds_coeffs,
-                shear_LDS_coeff_list=computed_shear_forces_lds_coeffs,
-            )
+            if len(pobj_list) > 0:
+                press_varname = None
+                shear_varname = None
+                if press_var_obj:
+                    _press_var_id = convert_variable(self.ensight, press_var_obj)
+                    if _press_var_id:
+                        press_varnames = [
+                            v for v in self.ensight.objs.core.VARIABLES if v.ID == _press_var_id
+                        ]
+                        if press_varnames:
+                            press_varname = str(press_varnames[0].DESCRIPTION)
+                if shear_var_obj:
+                    _shear_var_id = convert_variable(self.ensight, shear_var_obj)
+                    if _shear_var_id:
+                        shear_varnames = [
+                            v for v in self.ensight.objs.core.VARIABLES if v.ID == _press_var_id
+                        ]
+                        if shear_varnames:
+                            shear_varname = str(shear_varnames[0].DESCRIPTION)
+                params = {}
+                if press_varname:
+                    params["press_varname"] = press_varname
+                if shear_varname:
+                    params["shear_varname"] = shear_varname
+                if shear_var_type is not None:
+                    value = shear_map.get(shear_var_type)
+                    if value:
+                        params["shear_vartype"] = value
+                if area_ref:
+                    params["Area_ref"] = str(area_ref)
+                if density_ref:
+                    params["Dens_ref"] = str(density_ref)
+                if velocity_x_ref:
+                    params["Vx_ref"] = str(velocity_x_ref)
+                if velocity_y_ref:
+                    params["Vy_ref"] = str(velocity_y_ref)
+                if velocity_z_ref:
+                    params["Vz_ref"] = str(velocity_z_ref)
+                if up_vector:
+                    params["up_vector"] = up_vector
+                if frame_index > 0:
+                    params["frame_index"] = str(frame_index)
+
+                self._write_out_force_data(
+                    export_filename,
+                    _pobj_list,
+                    params=params,
+                    press_force_list=computed_press_forces,
+                    shear_force_list=computed_shear_forces,
+                    press_coeff_list=computed_press_force_coeffs,
+                    shear_coeff_list=computed_shear_force_coeffs,
+                    press_LDS_force_list=computed_press_forces_lds,
+                    shear_LDS_force_list=computed_shear_forces_lds,
+                    press_LDS_coeff_list=computed_press_forces_lds_coeffs,
+                    shear_LDS_coeff_list=computed_shear_forces_lds_coeffs,
+                )
         return {
             "pressure_forces": {
                 p.DESCRIPTION: computed_press_forces[idx]