ansys-pyensight-core 0.8.3__tar.gz → 0.8.4__tar.gz

{ansys_pyensight_core-0.8.3 → ansys_pyensight_core-0.8.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: ansys-pyensight-core
-Version: 0.8.3
+Version: 0.8.4
 Summary: A python wrapper for Ansys EnSight
 Author-email: "ANSYS, Inc." <pyansys.core@ansys.com>
 Maintainer-email: "ANSYS, Inc." <pyansys.core@ansys.com>
@@ -17,7 +17,7 @@ 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: requests>=2.28.2,<2.32
+Requires-Dist: requests>=2.28.2
 Requires-Dist: docker>=6.1.0
 Requires-Dist: urllib3<2
 Requires-Dist: numpy>=1.21.0,<2
@@ -37,7 +37,7 @@ Requires-Dist: sphinx-gallery==0.13.0 ; extra == "doc"
 Requires-Dist: sphinxcontrib-mermaid==0.9.2 ; extra == "doc"
 Requires-Dist: docker>=6.1.0 ; extra == "doc"
 Requires-Dist: matplotlib==3.7.2 ; extra == "doc"
-Requires-Dist: requests>=2.28.2,<2.32 ; extra == "doc"
+Requires-Dist: requests>=2.28.2 ; extra == "doc"
 Requires-Dist: sphinxcontrib.jquery==4.1 ; extra == "doc"
 Requires-Dist: coverage-badge==1.1.0 ; extra == "doc"
 Requires-Dist: sphinxcontrib-openapi==0.8.1 ; extra == "doc"
@@ -47,7 +47,7 @@ Requires-Dist: pytest-cov==4.1.0 ; extra == "tests"
 Requires-Dist: dill>=0.3.5.1 ; extra == "tests"
 Requires-Dist: pytest-mock==3.10.0 ; extra == "tests"
 Requires-Dist: urllib3==1.26.10 ; extra == "tests"
-Requires-Dist: requests>=2.28.2,<2.32 ; extra == "tests"
+Requires-Dist: requests>=2.28.2 ; extra == "tests"
 Requires-Dist: docker>=6.1.0 ; extra == "tests"
 Project-URL: Changelog, https://github.com/ansys/pyensight/blob/main/CHANGELOG.rst
 Project-URL: Documentation, https://ensight.docs.pyansys.com/

{ansys_pyensight_core-0.8.3 → ansys_pyensight_core-0.8.4}/pyproject.toml

@@ -6,7 +6,7 @@ build-backend = "flit_core.buildapi"
 
 [project]
 name = "ansys-pyensight-core"
-version = "0.8.3"
+version = "0.8.4"
 description = "A python wrapper for Ansys EnSight"
 readme = "README.rst"
 requires-python = ">=3.9,<4"
@@ -28,7 +28,7 @@ classifiers = [
 dependencies = [
     "importlib-metadata>=4.0; python_version<='3.8'",
     "ansys-api-pyensight==0.4.1",
-    "requests>=2.28.2,<2.32",
+    "requests>=2.28.2",
     "docker>=6.1.0",
     "urllib3<2",
     "numpy>=1.21.0,<2",
@@ -51,7 +51,7 @@ tests = [
     "dill>=0.3.5.1",
     "pytest-mock==3.10.0",
     "urllib3==1.26.10",
-    "requests>=2.28.2,<2.32",
+    "requests>=2.28.2",
     "docker>=6.1.0",
 ]
 doc = [
@@ -63,7 +63,7 @@ doc = [
     "sphinxcontrib-mermaid==0.9.2",
     "docker>=6.1.0",
     "matplotlib==3.7.2",
-    "requests>=2.28.2,<2.32",
+    "requests>=2.28.2",
     "sphinxcontrib.jquery==4.1",
     "coverage-badge==1.1.0",
     "sphinxcontrib-openapi==0.8.1",

{ansys_pyensight_core-0.8.3 → ansys_pyensight_core-0.8.4}/src/ansys/pyensight/core/utils/dsg_server.py

@@ -100,9 +100,6 @@ class Part(object):
         It will duplicate triangles as needed (to preserve element normals) and will convert
         variable data into texture coordinates.
 
-        Note: this call can only be made once as the internal structures are released when this
-        call is made.
-
         Returns
         -------
         On failure, the method returns None for the first return value.  The returned tuple is:
@@ -122,7 +119,6 @@ class Part(object):
             self.session.log(
                 f"Note: part '{self.cmd.name}' contains lines which are not currently supported."
             )
-            self.cmd = None
             return None, None, None, None, None, None
         verts = self.coords
         if self.session.normalize_geometry and self.session.scene_bounds is not None:
@@ -285,8 +281,9 @@ class UpdateHandler(object):
 
     def finalize_part(self, part: Part) -> None:
         """Called when all the updates on a Part object have been completed.
-        Note: this should be called after the subclass has processed the part
-        as the part command will be destroyed by this call.
+
+        Note: this superclass method should be called after the subclass has processed
+        the part geometry as the saved part command will be destroyed by this call.
         """
         if part.cmd:
             self.session.log(f"Part finalized: {part.cmd.name}")

{ansys_pyensight_core-0.8.3 → ansys_pyensight_core-0.8.4}/src/ansys/pyensight/core/utils/omniverse.py

@@ -19,13 +19,6 @@ class Omniverse:
     The omniverse class methods provide an interface between an EnSight session
     and an Omniverse instance.  See :ref:`omniverse_info` for additional details.
 
-    Note
-    ----
-    This interface is only available when using pyensight (they do not work with
-    the ensight Python interpreter) and the module must be used in an interpreter
-    that includes the Omniverse Python modules (e.g. omni and pxr).  Only a single
-    Omniverse connection can be established within a single pyensight session.
-
     Parameters
     ----------
     interface:
@@ -33,8 +26,15 @@ class Omniverse:
         EnSight Python, the ``ensight`` module is passed. In the case
         of PyEnSight, ``Session.ensight`` is passed.
 
-    Example
-    -------
+    Notes
+    -----
+    This interface is only available when using pyensight (they do not work with
+    the ensight Python interpreter) and the module must be used in an interpreter
+    that includes the Omniverse Python modules (e.g. omni and pxr).  Only a single
+    Omniverse connection can be established within a single pyensight session.
+
+    Examples
+    --------
     ::
         from ansys.pyensight.core import LocalLauncher
         session = LocalLauncher().start()

{ansys_pyensight_core-0.8.3 → ansys_pyensight_core-0.8.4}/src/ansys/pyensight/core/utils/parts.py

@@ -1081,7 +1081,7 @@ class Parts:
         Returns
         -------
         list
-            list of part objects selected or None if error.
+            A list of part objects selected or None if error.
 
 
         NOTE: If you do not want a measured part in your
@@ -1116,7 +1116,7 @@ class Parts:
         ret_flag="id",
     ) -> Union[Optional[List[int]], Optional[List[str]], Optional[List["ENS_PART"]]]:
         """
-        input a part or a list of parts and return an id, object, or name
+        Input a part or a list of parts and return an id, object, or name
         or a list of ids, objects, or names.
 
         Parameters
@@ -1125,13 +1125,13 @@ class Parts:
             The list of part objects to compute the forces on. It can either be a list of names
             a list of IDs (integers or strings) or directly a list of ENS_PART objects
 
-        ret_flag: string
-            a string that determines what is returned
+        ret_flag: str
+            A string that determines what is returned
 
         Returns
         -------
         list
-            either a list of part IDs, or a list of names or a list of ENS_PART objects
+            Either a list of part IDs, or a list of names or a list of ENS_PART objects
             depending on the requested ret_flag value
         """
         # To not change the interface I didn't move ret_flag to be a required argument,

{ansys_pyensight_core-0.8.3 → ansys_pyensight_core-0.8.4}/src/ansys/pyensight/core/utils/variables.py

@@ -54,7 +54,42 @@ class Variables:
 
     @property
     def calculator(self) -> "ens_calculator":
-        """Return the instance of the calculator functions class"""
+        """
+        The calculator interface presents a Pythonic mechanism to access all the
+        EnSight calculator functions: :doc:`Calculator Functions <../calc_functions>`.
+
+        Unlike the native API function :func:`pyensight.ensight_api.variables.evaluate`
+        and the object API function :func:`pyensight.ens_globals.ENS_GLOBALS.create_variable`
+        which take a string as the function definition, the methods on the calculator
+        object take natural Python objects and return any newly created ``ENS_VARIABLE``
+        object.
+
+        Returns
+        -------
+        ens_calculator
+            An object supporting a method for each EnSight calculator function.
+
+        Examples
+        --------
+        The following are equavalent:
+
+        >>> # Native API
+        >>> session.ensight.part.select_all()
+        >>> session.ensight.variables.evaluate("EleSize = EleSize(plist)")
+        >>> var1 = session.ensight.objs.core.VARIABLES["EleSize"][0]
+        >>> session.ensight.variables.evaluate("OffsetVar = OffsetVar(plist,Momentum,2e-05)")
+        >>> var2 = session.ensight.objs.core.VARIABLES["OffsetVar"][0]
+        >>> # Object API
+        >>> parts = session.ensight.objs.core.PARTS
+        >>> var1 = session.ensight.objs.core.create_variable("EleSize", "EleSize(plist)", sources=parts)
+        >>> var2 = session.ensight.objs.core.create_variable("OffsetVar", "OffsetVar(plist,Momentum,2e-05)", sources=parts)
+        >>> # ens_calculator API
+        >>> parts = session.ensight.objs.core.PARTS
+        >>> var1 = session.ensight.utils.variables.calculator.elesize(parts, output_varname="EleSize")
+        >>> momentum = session.objs.core.PARTS["Momentum"]
+        >>> var2 = session.ensight.utils.variables.calculator.offsetvar(parts, momentum[0], 2.e-5, output_varname="OffsetVar")
+
+        """
         return self._calculator
 
     def _check_for_var_elem(