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

ansys/pyensight/core/libuserd.py

@@ -601,6 +601,79 @@ class Reader(object):
         for key in pb.metadata.keys():
             self.metadata[key] = pb.metadata[key]
         self.raw_metadata = pb.raw_metadata
+        self._timesets: List["numpy.array"] = []
+        self._update_timesets()
+
+    def _update_timesets(self) -> None:
+        """
+        To simplify the interface to time, the timesets are all queried and
+        cached.  Additionally, a "common timeset" is generated that combines
+        all the timevalues from all timesets into a single timeset which is
+        saved as "timeset 0".
+
+        This method reads all the timesets and generates the common timeset.
+        """
+        if len(self._timesets):
+            return
+        num_timesets = self.get_number_of_time_sets()
+        # The common timeset
+        common = set()
+        self._timesets = [numpy.array([], dtype="float32")]
+        # The other timesets
+        for ts in range(1, num_timesets + 1):
+            v = self.timevalues(timeset=ts)
+            # merge into the common timeset
+            common.update(v)
+            self._timesets.append(v)
+        self._timesets[0] = numpy.array(sorted(list(common)))
+
+    def _common_set_step(self, s: int) -> None:
+        """
+        When the common timeset is used in a ``set_timestep()`` call, this
+        method selects the time value from the common timeset and then calls
+        ``_common_set_time()`` to change the current simulation time.
+
+        Parameters
+        ----------
+        s : int
+            The index (timestep) in the common timeset to change the current time to.
+
+        Raises
+        ------
+        RuntimeError
+            If the timestep index is invalid.
+
+        """
+        try:
+            v = self._timesets[0][s]
+            self._common_set_time(v)
+        except IndexError:
+            raise RuntimeError(f"Invalid step number {s}.") from None
+
+    def _common_set_time(self, t: float) -> None:
+        """
+        Change the current time value to the passed time value.  This method
+        walks all the timesets.  It selects the largest time value in each timeset
+        that is less than or equal to the specified time value.  It then sets
+        the time value for each timeset accordingly.
+
+        Parameters
+        ----------
+        t : float
+            The time value (in the common timeset) to change the reader simulation time to.
+
+        """
+        # given the time float from the common timeline,
+        # change the timestep in all the timesets to match.
+        for timeset in range(1, len(self._timesets)):
+            # check for perfect match first (avoids rounding)
+            where = numpy.where(self._timesets[timeset] == t)
+            if len(where[0]):
+                timestep = where[0][0]
+            else:
+                timestep = numpy.searchsorted(self._timesets[timeset], t)
+                timestep = min(timestep, len(self._timesets[timeset]) - 1)
+            self.set_timestep(timestep, timeset=timeset)
 
     def parts(self) -> List[Part]:
         """
@@ -671,6 +744,8 @@ class Reader(object):
         int
             The number of timesets.
         """
+        if len(self._timesets):
+            return len(self._timesets) - 1
         self._userd.connect_check()
         pb = libuserd_pb2.Reader_get_number_of_time_setsRequest()
         try:
@@ -681,20 +756,27 @@ class Reader(object):
             raise self._userd.libuserd_exception(e)
         return reply.numberOfTimeSets
 
-    def timevalues(self, timeset: int = 1) -> List[float]:
+    def timevalues(self, timeset: int = 0) -> List[float]:
         """
-        Get a list of the time step values in this dataset.
+        Get a list of the time step values in this dataset for the specified timeset.
+        The default timeset is ``0`` which is a special, "common" timeset formed by
+        merging all the timesets in the data into a single timeset.
 
         Parameters
         ----------
         timeset : int, optional
-            The timestep to query (default is 1)
+            The timestep to query (default is 0)
 
         Returns
         -------
-        List[float]
-            A list of time floats.
+        numpy.array
+            The simulation time value floats.
         """
+        if timeset == 0:
+            try:
+                return self._timesets[timeset]
+            except IndexError:
+                return numpy.array([], dtype="float32")
         self._userd.connect_check()
         pb = libuserd_pb2.Reader_timevaluesRequest()
         pb.timeSetNumber = timeset
@@ -704,18 +786,43 @@ class Reader(object):
             raise self._userd.libuserd_exception(e)
         return numpy.array(timevalues.timeValues)
 
-    def set_timevalue(self, timevalue: float, timeset: int = 1) -> None:
+    def set_timevalue(self, timevalue: float, timeset: int = 0) -> None:
         """
-        Change the current time to the specified value.  This value should ideally
-        be on of the values returned by `timevalues`
+        Change the current time within the selected timeset to the specified value.
+        The default timeset selected is the merged "common" timeset ``0``.  If the
+        "common" timeset is used, the appropriate time value will be set for
+        all timesets by this method.
 
         Parameters
         ----------
         timevalue : float
             The time value to change the timestep closest to.
         timeset : int, optional
-            The timestep to query (default is 1)
-        """
+            The timeset to change (default is 0)
+
+        Examples
+        --------
+        >>> from ansys.pyensight.core import libuserd
+        >>> import numpy
+        >>> s = libuserd.LibUserd()
+        >>> s.initialize()
+        >>> opt = {'Long names': 0, 'Number of timesteps': 5, 'Number of scalars': 3,
+        ...        'Number of spheres': 2, 'Number of cubes': 2}
+        >>> d = s.load_data("foo", file_format="Synthetic", reader_options=opt)
+        >>> parts = d.parts()
+        >>> for t in d.timevalues():
+        ...    d.set_timevalue(t)
+        ...    for p in parts:
+        ...        nodes = p.nodes()
+        ...        nodes.shape = (len(nodes)//3, 3)
+        ...        centroid = numpy.average(nodes, 0)
+        ...        print(f"Time: {t} Part: {p.name} Centroid: {centroid}")
+        >>> s.shutdown()
+
+        """
+        if timeset == 0:
+            self._common_set_time(timevalue)
+            return
         self._userd.connect_check()
         pb = libuserd_pb2.Reader_set_timevalueRequest()
         pb.timesetNumber = timeset
@@ -725,18 +832,24 @@ class Reader(object):
         except grpc.RpcError as e:
             raise self._userd.libuserd_exception(e)
 
-    def set_timestep(self, timestep: int, timeset: int = 1) -> None:
+    def set_timestep(self, timestep: int, timeset: int = 0) -> None:
         """
         Change the current time to the specified timestep.  This call is the same as:
         ``reader.set_timevalue(reader.timevalues()[timestep])``.
+        The default timeset selected is the merged "common" timeset ``0``.  If the
+        "common" timeset is used, the appropriate time value will be set for
+        all timesets by this method.
 
         Parameters
         ----------
         timestep : int
             The timestep to change to.
         timeset : int, optional
-            The timestep to query (default is 1)
+            The timeset to change (default is 0)
         """
+        if timeset == 0:
+            self._common_set_step(timestep)
+            return
         self._userd.connect_check()
         pb = libuserd_pb2.Reader_set_timestepRequest()
         pb.timeSetNumber = timeset
@@ -1733,7 +1846,7 @@ class LibUserd(object):
         try:
             output = the_reader.read_dataset(data_file, result_file)
         except Exception:
-            raise RuntimeError("Unable to open the specified dataset.")
+            raise RuntimeError("Unable to open the specified dataset.") from None
 
         return output
 

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-0.8.10.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.10
+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>

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

@@ -8,7 +8,7 @@ ansys/pyensight/core/ensight_grpc.py,sha256=BJaErleSPrtI8myTIh0m9awFWPaUxrQmHpbu
 ansys/pyensight/core/ensobj.py,sha256=uDtM2KHcAwd4hu5pcUYWbSD729ApHGIvuqZhEq8PxTI,18558
 ansys/pyensight/core/launch_ensight.py,sha256=iZJM6GdpzGRDLzrv1V2QZ5veIOpNSB5xPpJUFY7rBuo,10254
 ansys/pyensight/core/launcher.py,sha256=ymwfixwoHO7_c4qOetqccQbZjGT1HjeA7jwPi2JxlmE,10585
-ansys/pyensight/core/libuserd.py,sha256=nHHf_iI7eBQ6Z48LqTBDjw0gwz3hrFvqwsKm7kFqJY4,67912
+ansys/pyensight/core/libuserd.py,sha256=P5ewBFey_a9YYhRhbWSCCy2KXtyccsJyyLWlYh-Hxgo,72592
 ansys/pyensight/core/listobj.py,sha256=Trw87IxIMXtmUd1DzywRmMzORU704AG4scX4fqYmO6M,9340
 ansys/pyensight/core/locallauncher.py,sha256=MnSyKVe0JGXN0YJ9f_msw_TBbLGfqDpjWWC4-haAjJ4,16205
 ansys/pyensight/core/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
@@ -19,7 +19,7 @@ ansys/pyensight/core/utils/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJ
 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
@@ -30,7 +30,7 @@ ansys/pyensight/core/utils/support.py,sha256=QI3z9ex7zJxjFbkCPba9DWqWgPFIThORqr0
 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.10.dist-info/LICENSE,sha256=qQWivZ12ETN5l3QxvTARY-QI5eoRRlyHdwLlAj0Bg5I,1089
-ansys_pyensight_core-0.8.10.dist-info/WHEEL,sha256=EZbGkh7Ie4PoZfRQ8I0ZuP9VklN_TvcZ6DSE5Uar4z4,81
-ansys_pyensight_core-0.8.10.dist-info/METADATA,sha256=zQdULyTEURXiRUbAn_kaBYl2bB6NQYwwIhE_9PGZja4,11999
-ansys_pyensight_core-0.8.10.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,,