ansys-speos-core 0.6.0__tar.gz → 0.6.1__tar.gz

{ansys_speos_core-0.6.0 → ansys_speos_core-0.6.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ansys-speos-core
-Version: 0.6.0
+Version: 0.6.1
 Summary: A Python wrapper for Ansys Speos
 Author-email: "ANSYS, Inc." <pyansys.core@ansys.com>
 Maintainer-email: "ANSYS, Inc." <pyansys.core@ansys.com>
@@ -21,13 +21,13 @@ Classifier: Topic :: Scientific/Engineering :: Physics
 Classifier: Topic :: Scientific/Engineering :: Information Analysis
 License-File: LICENSE
 Requires-Dist: protobuf>=3.20,<7
-Requires-Dist: grpcio>=1.50.0,<1.71
+Requires-Dist: grpcio>=1.50.0,<1.75
 Requires-Dist: grpcio-health-checking>=1.45.0,<1.68
-Requires-Dist: ansys-api-speos==0.15.2
+Requires-Dist: ansys-api-speos==0.15.3
 Requires-Dist: ansys-tools-path>=0.3.1
 Requires-Dist: numpy>=1.20.3,<3
-Requires-Dist: comtypes>=1.4,<1.5
-Requires-Dist: ansys-sphinx-theme==1.5.2 ; extra == "doc"
+Requires-Dist: comtypes>=1.4,<1.5; platform_system=='Windows'
+Requires-Dist: ansys-sphinx-theme==1.6.0 ; extra == "doc"
 Requires-Dist: numpydoc==1.8.0 ; extra == "doc"
 Requires-Dist: Sphinx==8.1.3 ; extra == "doc"
 Requires-Dist: sphinx-copybutton==0.5.2 ; extra == "doc"
@@ -37,26 +37,26 @@ Requires-Dist: sphinx-jinja==2.0.2 ; extra == "doc"
 Requires-Dist: sphinxcontrib-mermaid==1.0.0 ; extra == "doc"
 Requires-Dist: myst-parser==4.0.1 ; extra == "doc"
 Requires-Dist: nbsphinx==0.9.7 ; extra == "doc"
-Requires-Dist: jupytext==1.17.2 ; extra == "doc"
-Requires-Dist: jupyterlab==4.4.3 ; extra == "doc"
-Requires-Dist: jupyter-server==2.16.0 ; extra == "doc"
+Requires-Dist: jupytext==1.17.3 ; extra == "doc"
+Requires-Dist: jupyterlab==4.4.7 ; extra == "doc"
+Requires-Dist: jupyter-server==2.17.0 ; extra == "doc"
 Requires-Dist: nbconvert==7.16.6 ; extra == "doc"
-Requires-Dist: pyvista[jupyter]>=0.43,<0.46 ; extra == "doc"
+Requires-Dist: pyvista[jupyter]>=0.43,<0.47 ; extra == "doc"
 Requires-Dist: ansys-tools-visualization-interface>=0.8.3 ; extra == "doc"
-Requires-Dist: pyvista>=0.40.0,<0.46 ; extra == "graphics"
+Requires-Dist: pyvista>=0.40.0,<0.47 ; extra == "graphics"
 Requires-Dist: ansys-tools-visualization-interface>=0.8.3 ; extra == "graphics"
 Requires-Dist: matplotlib ; extra == "jupyter"
 Requires-Dist: jupyterlab>=3 ; extra == "jupyter"
 Requires-Dist: ipywidgets ; extra == "jupyter"
-Requires-Dist: pyvista[jupyter]>=0.43,<0.46 ; extra == "jupyter"
+Requires-Dist: pyvista[jupyter]>=0.43,<0.47 ; extra == "jupyter"
 Requires-Dist: ansys-tools-visualization-interface>=0.8.3 ; extra == "jupyter"
-Requires-Dist: notebook==7.4.3 ; extra == "jupyter"
+Requires-Dist: notebook==7.4.5 ; extra == "jupyter"
 Requires-Dist: psutil==7.0.0 ; extra == "tests"
-Requires-Dist: pytest==8.4.1 ; extra == "tests"
-Requires-Dist: pyvista>=0.40.0,<0.46 ; extra == "tests"
+Requires-Dist: pytest==8.4.2 ; extra == "tests"
+Requires-Dist: pyvista>=0.40.0,<0.47 ; extra == "tests"
 Requires-Dist: ansys-tools-visualization-interface>=0.8.3 ; extra == "tests"
 Requires-Dist: ansys-platform-instancemanagement>=1.0.3 ; extra == "tests"
-Requires-Dist: pytest-cov==6.2.1 ; extra == "tests"
+Requires-Dist: pytest-cov==6.3.0 ; extra == "tests"
 Project-URL: Changelog, https://github.com/ansys/pyspeos/blob/main/doc/source/changelog.rst
 Project-URL: Discussions, https://github.com/ansys/pyspeos/discussions
 Project-URL: Documentation, https://speos.docs.pyansys.com/
@@ -102,7 +102,7 @@ PySpeos library
 
 Project overview
 ----------------
-``PySpeos`` is a Python library that gathers functionalities and tools based on remote API of Ansys software `Speos <https://www.ansys.com/products/optics>`_ .
+``PySpeos`` is a Python library that gathers functionalities and tools based on remote API provided by gRPC server of Ansys software `Speos <https://www.ansys.com/products/optics>`_ .
 
 Installation
 ------------
@@ -110,7 +110,6 @@ Installation can be done using the published `package`_ or the repository `sourc
 
 Package
 ~~~~~~~
-.. warning:: Release is in progress. It might take some time before it becomes available. Until then, please use `Sources`_.
 
 This repository is deployed as the Python packages `ansys-speos-core <https://pypi.org/project/ansys-speos-core>`_.
 As usual, installation is done by running:
@@ -262,6 +261,33 @@ Use jupyter notebook
 
 jupyter notebook can be downloaded from the documentations example section.
 
+Features
+--------
+
+Information of the latest stable release features:
+
+PySpeos core features
+~~~~~~~~~~~~~~~~~~~~~
+
+Features supported in the latest release can be found at:
+
+* `Optical Materials <https://speos.docs.pyansys.com/version/stable/api/ansys/speos/core/opt_prop/OptProp.html>`_
+* `Light Sources <https://speos.docs.pyansys.com/version/stable/api/ansys/speos/core/source/index.html>`_
+* `Sensors <https://speos.docs.pyansys.com/version/stable/api/ansys/speos/core/sensor/index.html>`_
+* `Simulations <https://speos.docs.pyansys.com/version/stable/api/ansys/speos/core/simulation/index.html>`_
+* `BSDF Viewer <https://speos.docs.pyansys.com/version/stable/api/ansys/speos/core/bsdf/index.html>`_
+* `Light Path Finder <https://speos.docs.pyansys.com/version/stable/api/ansys/speos/core/lxp/LightPathFinder.html>`_
+
+Speos RPC features
+~~~~~~~~~~~~~~~~~~
+
+Speos RPC is based on a gRPC server and provides APIs to interact with Speos solver.
+
+Features supported in the latest Speos RPC can be found at:
+`Ansys Speos for developers Speos RPC <https://developer.ansys.com/docs/speos>`_.
+
+
+
 License
 -------
 `PySpeos`_ is licensed under the MIT license.

{ansys_speos_core-0.6.0 → ansys_speos_core-0.6.1}/README.rst

@@ -32,7 +32,7 @@ PySpeos library
 
 Project overview
 ----------------
-``PySpeos`` is a Python library that gathers functionalities and tools based on remote API of Ansys software `Speos <https://www.ansys.com/products/optics>`_ .
+``PySpeos`` is a Python library that gathers functionalities and tools based on remote API provided by gRPC server of Ansys software `Speos <https://www.ansys.com/products/optics>`_ .
 
 Installation
 ------------
@@ -40,7 +40,6 @@ Installation can be done using the published `package`_ or the repository `sourc
 
 Package
 ~~~~~~~
-.. warning:: Release is in progress. It might take some time before it becomes available. Until then, please use `Sources`_.
 
 This repository is deployed as the Python packages `ansys-speos-core <https://pypi.org/project/ansys-speos-core>`_.
 As usual, installation is done by running:
@@ -192,6 +191,33 @@ Use jupyter notebook
 
 jupyter notebook can be downloaded from the documentations example section.
 
+Features
+--------
+
+Information of the latest stable release features:
+
+PySpeos core features
+~~~~~~~~~~~~~~~~~~~~~
+
+Features supported in the latest release can be found at:
+
+* `Optical Materials <https://speos.docs.pyansys.com/version/stable/api/ansys/speos/core/opt_prop/OptProp.html>`_
+* `Light Sources <https://speos.docs.pyansys.com/version/stable/api/ansys/speos/core/source/index.html>`_
+* `Sensors <https://speos.docs.pyansys.com/version/stable/api/ansys/speos/core/sensor/index.html>`_
+* `Simulations <https://speos.docs.pyansys.com/version/stable/api/ansys/speos/core/simulation/index.html>`_
+* `BSDF Viewer <https://speos.docs.pyansys.com/version/stable/api/ansys/speos/core/bsdf/index.html>`_
+* `Light Path Finder <https://speos.docs.pyansys.com/version/stable/api/ansys/speos/core/lxp/LightPathFinder.html>`_
+
+Speos RPC features
+~~~~~~~~~~~~~~~~~~
+
+Speos RPC is based on a gRPC server and provides APIs to interact with Speos solver.
+
+Features supported in the latest Speos RPC can be found at:
+`Ansys Speos for developers Speos RPC <https://developer.ansys.com/docs/speos>`_.
+
+
+
 License
 -------
 `PySpeos`_ is licensed under the MIT license.

{ansys_speos_core-0.6.0 → ansys_speos_core-0.6.1}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "flit_core.buildapi"
 
 [project]
 name = "ansys-speos-core"
-version = "0.6.0"
+version = "0.6.1"
 description = "A Python wrapper for Ansys Speos"
 readme = "README.rst"
 requires-python = ">=3.10"
@@ -28,37 +28,37 @@ classifiers=[
 ]
 dependencies=[
     "protobuf>=3.20,<7",
-    "grpcio>=1.50.0,<1.71",
+    "grpcio>=1.50.0,<1.75",
     "grpcio-health-checking>=1.45.0,<1.68",
-    "ansys-api-speos==0.15.2",
+    "ansys-api-speos==0.15.3",
     "ansys-tools-path>=0.3.1",
     "numpy>=1.20.3,<3",
-    "comtypes>=1.4,<1.5",
+    "comtypes>=1.4,<1.5; platform_system=='Windows'",
 ]
 
 [project.optional-dependencies]
 graphics = [
-    "pyvista>=0.40.0,<0.46",
+    "pyvista>=0.40.0,<0.47",
     "ansys-tools-visualization-interface>=0.8.3",
 ]
 tests = [
     "psutil==7.0.0",
-    "pytest==8.4.1",
-    "pyvista>=0.40.0,<0.46",
+    "pytest==8.4.2",
+    "pyvista>=0.40.0,<0.47",
     "ansys-tools-visualization-interface>=0.8.3",
     "ansys-platform-instancemanagement>=1.0.3",
-    "pytest-cov==6.2.1",
+    "pytest-cov==6.3.0",
 ]
 jupyter = [
     "matplotlib",
     "jupyterlab>=3",
     "ipywidgets",
-    "pyvista[jupyter]>=0.43,<0.46",
+    "pyvista[jupyter]>=0.43,<0.47",
     "ansys-tools-visualization-interface>=0.8.3",
-    "notebook==7.4.3",
+    "notebook==7.4.5",
 ]
 doc = [
-    "ansys-sphinx-theme==1.5.2",
+    "ansys-sphinx-theme==1.6.0",
     "numpydoc==1.8.0",
     "Sphinx==8.1.3",
     "sphinx-copybutton==0.5.2",
@@ -68,11 +68,11 @@ doc = [
     "sphinxcontrib-mermaid==1.0.0",
     "myst-parser==4.0.1",
     "nbsphinx==0.9.7",
-    "jupytext==1.17.2",
-    "jupyterlab==4.4.3",
-    "jupyter-server==2.16.0",
+    "jupytext==1.17.3",
+    "jupyterlab==4.4.7",
+    "jupyter-server==2.17.0",
     "nbconvert==7.16.6",
-    "pyvista[jupyter]>=0.43,<0.46",
+    "pyvista[jupyter]>=0.43,<0.47",
     "ansys-tools-visualization-interface>=0.8.3",
 ]
 

{ansys_speos_core-0.6.0 → ansys_speos_core-0.6.1}/src/ansys/speos/core/generic/constants.py

@@ -28,7 +28,7 @@ DEFAULT_HOST: str = "localhost"
 """Default host used by Speos RPC server and client """
 DEFAULT_PORT: str = "50098"
 """Default port used by Speos RPC server and client """
-DEFAULT_VERSION: str = "251"
+DEFAULT_VERSION: str = "252"
 """Latest supported Speos version of the current PySpeos Package"""
 MAX_SERVER_MESSAGE_LENGTH: int = int(os.environ.get("SPEOS_MAX_MESSAGE_LENGTH", 256 * 1024**2))
 """Maximum message length value accepted by the Speos RPC server,

{ansys_speos_core-0.6.0 → ansys_speos_core-0.6.1}/src/ansys/speos/core/kernel/face.py

@@ -304,7 +304,7 @@ class FaceStub(CrudStub):
                             sizes=[
                                 len(message.vertices),
                                 len(message.facets),
-                                len(message.texture_coordinates_channels),
+                                len(message.vertices_data),
                             ],
                         )
                     )

{ansys_speos_core-0.6.0 → ansys_speos_core-0.6.1}/src/ansys/speos/core/kernel/scene.py

@@ -31,6 +31,7 @@ from ansys.api.speos.scene.v2 import (
 )
 from ansys.speos.core.kernel.crud import CrudItem, CrudStub
 from ansys.speos.core.kernel.proto_message_utils import protobuf_message_to_str
+from ansys.speos.core.kernel.sop_template import ProtoSOPTemplate, SOPTemplateStub
 
 ProtoScene = messages.Scene
 """Scene protobuf class : ansys.api.speos.scene.v2.scene_pb2.Scene"""
@@ -171,6 +172,39 @@ class SceneStub(CrudStub):
     def __init__(self, channel):
         super().__init__(stub=service.ScenesManagerStub(channel=channel))
         self._actions_stub = service.SceneActionsStub(channel=channel)
+        self._is_texture_available = self._check_if_texture_available(channel=channel)
+
+    def _check_if_texture_available(self, channel) -> bool:
+        sop_t_stub = SOPTemplateStub(channel=channel)
+        # Create SOPTemplate then scene
+        sop_t_link = sop_t_stub.create(
+            message=ProtoSOPTemplate(
+                name="checkForTextureAvailability",
+                optical_polished=ProtoSOPTemplate.OpticalPolished(),
+            )
+        )
+        sce_link = self.create(
+            ProtoScene(
+                name="checkForTextureAvailability",
+                materials=[
+                    ProtoScene.MaterialInstance(
+                        name="checkForTextureAvailability", sop_guid=sop_t_link.key
+                    )
+                ],
+            )
+        )
+
+        # Read scene (aim is to see if the server knows the new field sop_guid or just ignored it)
+        sce_msg = sce_link.get()
+
+        # Don't forget to delete created objects
+        sop_t_link.delete()
+        sce_link.delete()
+
+        # Check presence of sop_guid field -> if yes then texture is available
+        if sce_msg.materials[0].HasField("sop_guid"):
+            return True
+        return False
 
     def create(self, message: ProtoScene = None) -> SceneLink:
         """Create a new entry.

{ansys_speos_core-0.6.0 → ansys_speos_core-0.6.1}/src/ansys/speos/core/opt_prop.py

@@ -436,8 +436,13 @@ class OptProp:
                 self.sop_template_link = self._project.client.sop_templates().create(
                     message=self._sop_template
                 )
+                # Always clean sop_guids to be sure that we never use both sop_guids and sop_guid
                 self._material_instance.ClearField("sop_guids")
-                self._material_instance.sop_guids.append(self.sop_template_link.key)
+                # Fill sop_guid(s) field according to the server capability regarding textures
+                if self._project.client.scenes()._is_texture_available:
+                    self._material_instance.sop_guid = self.sop_template_link.key
+                else:
+                    self._material_instance.sop_guids.append(self.sop_template_link.key)
         elif self.sop_template_link.get() != self._sop_template:
             self.sop_template_link.set(
                 data=self._sop_template
@@ -519,7 +524,8 @@ class OptProp:
             self.sop_template_link.delete()
             self.sop_template_link = None
 
-        # Reset then the sop_guids (as the sop template was deleted just above)
+        # Reset then the sop_guid/sop_guids fields (as the sop template was deleted just above)
+        self._material_instance.ClearField("sop_guid")
         self._material_instance.ClearField("sop_guids")
 
         # Remove the material instance from the scene
@@ -537,11 +543,13 @@ class OptProp:
         self._material_instance.metadata.pop("UniqueId")
         return self
 
-    def _fill(self, mat_inst):
+    def _fill(self, mat_inst: ProtoScene.MaterialInstance):
         self._unique_id = mat_inst.metadata["UniqueId"]
         self._material_instance = mat_inst
         self.vop_template_link = self._project.client[mat_inst.vop_guid]
-        if len(mat_inst.sop_guids) > 0:
+        if mat_inst.HasField("sop_guid"):
+            self.sop_template_link = self._project.client[mat_inst.sop_guid]
+        elif len(mat_inst.sop_guids) > 0:
             self.sop_template_link = self._project.client[mat_inst.sop_guids[0]]
         else:  # Specific case for ambient material
             self._sop_template = None

{ansys_speos_core-0.6.0 → ansys_speos_core-0.6.1}/src/ansys/speos/core/part.py

@@ -295,14 +295,13 @@ class Part:
                     else:
                         update_part = False
                 else:
-                    self._parent_part._part.parts.append(
+                    parent_part_data.parts.append(
                         self._part_instance
                     )  # if no, just add it to the list of part instances
 
-                if self._parent_part.part_link is not None and update_part:
-                    self._parent_part.part_link.set(
-                        data=self._parent_part._part
-                    )  # update parent part
+                if update_part:
+                    self._parent_part._part = parent_part_data
+                    self._parent_part.part_link.set(data=parent_part_data)  # update parent part
 
             return self
 
@@ -360,11 +359,10 @@ class Part:
                     None,
                 )
                 if part_inst is not None:
-                    self._parent_part._part.parts.remove(part_inst)
+                    parent_part_data.parts.remove(part_inst)
+                    self._parent_part._part = parent_part_data
                     if self._parent_part.part_link is not None:
-                        self._parent_part.part_link.set(
-                            data=self._parent_part._part
-                        )  # update parent part
+                        self._parent_part.part_link.set(data=parent_part_data)  # update parent part
 
             # Reset the _unique_id
             self._unique_id = None

{ansys_speos_core-0.6.0 → ansys_speos_core-0.6.1}/src/ansys/speos/core/workflow/combine_speos.py

@@ -151,7 +151,7 @@ def _combine(
         part_data.parts.append(part_inst)
 
         for mat in scene_tmp_data.materials:
-            if len(mat.sop_guids) > 0:
+            if mat.HasField("sop_guid") or mat.HasField("texture") or len(mat.sop_guids) > 0:
                 mat.name = spc.name + "." + mat.name
                 mat.geometries.geo_paths[:] = [spc.name + "/" + x for x in mat.geometries.geo_paths]
                 scene_data.materials.append(mat)