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

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/utils/readers.py

@@ -26,7 +26,7 @@ class Readers:
         self._dvs = DVS(self._ensight)
 
     @property
-    def dvs(self):
+    def dvs(self) -> "DVS":
         return self._dvs
 
 

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(

{ansys_pyensight_core-0.8.1.dist-info → ansys_pyensight_core-0.8.4.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: ansys-pyensight-core
-Version: 0.8.1
+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>
@@ -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.0
+Requires-Dist: ansys-api-pyensight==0.4.1
 Requires-Dist: requests>=2.28.2
 Requires-Dist: docker>=6.1.0
 Requires-Dist: urllib3<2

{ansys_pyensight_core-0.8.1.dist-info → ansys_pyensight_core-0.8.4.dist-info}/RECORD

@@ -10,26 +10,27 @@ ansys/pyensight/core/launcher.py,sha256=nnNXKEsV82Eu1S9eSp8UzZI7YmSVHWyLhhOEbiYh
 ansys/pyensight/core/listobj.py,sha256=Trw87IxIMXtmUd1DzywRmMzORU704AG4scX4fqYmO6M,9340
 ansys/pyensight/core/locallauncher.py,sha256=sgaPrG-7ctXZ_ytGuHeriiVmgvI0kUeX6nKVJ4OiDUs,13984
 ansys/pyensight/core/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-ansys/pyensight/core/renderable.py,sha256=9jhkCBl9pKhTv_vukuk63hpfPCzt0DQNNJ-86CTN0yA,34557
+ansys/pyensight/core/renderable.py,sha256=hm4sXV-ZcpdfC_AJexycAX8zdsbWnsd-tMeUvewGekE,35003
 ansys/pyensight/core/session.py,sha256=AHTRbX0sDlvtUf8lyRoXetiICmLWO7n26Ni9lMy7tBY,74363
 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=NbJ_ZxFo89S0qzR1gnRvEAfQasbL_2Be5PJ0LrEYB_I,29159
 ansys/pyensight/core/utils/export.py,sha256=ZNpU3earAnRMBHZa6I8nTwMYY54WctXApJfMTkREBNA,23189
-ansys/pyensight/core/utils/omniverse.py,sha256=vKAl3rsUiL2pfaNk86bGH_PuZ6kB2DtXNqrsDJqjcqw,9456
-ansys/pyensight/core/utils/omniverse_dsg_server.py,sha256=Jzqt8fCwieSdkK7X7TynCmtXkQwhdNL5NPPWFHuRCTU,53281
-ansys/pyensight/core/utils/parts.py,sha256=0Qt54in6JoMrHksDa8wslZwcFH-miI1pB3BOFTn9x6Q,53373
+ansys/pyensight/core/utils/omniverse.py,sha256=YC5Uw2l2je462ysBGGd-a0Ncs2kWwaFYQi8YWjshZZs,9460
+ansys/pyensight/core/utils/omniverse_dsg_server.py,sha256=BVrSJILQWvUGQ0DI30CdYLmt3zD3VtYBPW52I_H23mA,32629
+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=DSCD36uHo6FaXcAP8vo-1H_FB95JkOsPFNu7tXWSN6o,11755
+ansys/pyensight/core/utils/readers.py,sha256=WUpmCtMo9BHlUOwGtIrD5jjyS9HE9wDak8eEjrYeR2Y,11764
 ansys/pyensight/core/utils/support.py,sha256=QI3z9ex7zJxjFbkCPba9DWqWgPFIThORqr0nvRfVjuc,4089
-ansys/pyensight/core/utils/variables.py,sha256=fXt-cwK1DX_Kt5Nbj4_tA_U7-hFCRE45VX-gJAZIoa0,93364
+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/utils/resources/Materials/Fieldstone.mdl,sha256=_7z4BzzrRGUH_x3urV4sc7t7WJBjJn4jWLOw1AQObgY,2035
 ansys/pyensight/core/utils/resources/Materials/Fieldstone/Fieldstone_BaseColor.png,sha256=CyxY5YrvbJxFzUUI-8Q90zOd6xwd85JPzjnUB-vPJ0s,501090
 ansys/pyensight/core/utils/resources/Materials/Fieldstone/Fieldstone_N.png,sha256=Az1m4bK-PWecsErsuZh4-kkUnui9w4TrCxrGwwI091I,795424
 ansys/pyensight/core/utils/resources/Materials/Fieldstone/Fieldstone_ORM.png,sha256=x0tUgUxjk53nsnleEy95tI1tUvFFQHGrB3pZVkd7b00,549202
-ansys_pyensight_core-0.8.1.dist-info/LICENSE,sha256=qQWivZ12ETN5l3QxvTARY-QI5eoRRlyHdwLlAj0Bg5I,1089
-ansys_pyensight_core-0.8.1.dist-info/WHEEL,sha256=EZbGkh7Ie4PoZfRQ8I0ZuP9VklN_TvcZ6DSE5Uar4z4,81
-ansys_pyensight_core-0.8.1.dist-info/METADATA,sha256=GJXaER5Dd2EG2FwdSBjRTMW8bbuHcd7tFAwH_V6h_w4,11830
-ansys_pyensight_core-0.8.1.dist-info/RECORD,,
+ansys_pyensight_core-0.8.4.dist-info/LICENSE,sha256=qQWivZ12ETN5l3QxvTARY-QI5eoRRlyHdwLlAj0Bg5I,1089
+ansys_pyensight_core-0.8.4.dist-info/WHEEL,sha256=EZbGkh7Ie4PoZfRQ8I0ZuP9VklN_TvcZ6DSE5Uar4z4,81
+ansys_pyensight_core-0.8.4.dist-info/METADATA,sha256=K5zU49tOXNW0xyQ0BvzKtm7Fr29OqNsAj2wvetO73Sk,11830
+ansys_pyensight_core-0.8.4.dist-info/RECORD,,