feat: core implementation irrad sensor v2 by pluAtAnsys · Pull Request #1102 · ansys/pyspeos

pluAtAnsys · 2026-08-17T12:45:20Z

Description

Update SensorIrradiance in sensor.py to transparently dispatch to sensor template v1 or v2 protobuf fields based on the connected Speos server version, without any change to the user-facing API.

Issue linked

Migrate SensorIrradiance to support sensor template v1 and v2
#1089

Checklist

I have tested my changes locally.
I have added necessary documentation or updated existing documentation.
I have followed the coding style guidelines of this project.
I have added appropriate tests (unit, integration, system).
I have reviewed my changes before submitting this pull request.
I have linked the issue or issues that are solved by the PR if any.
I have assigned this PR to myself.
I have made sure that the title of my PR follows Conventional commits style (e.g. feat: add optical property)
I have agreed with the Contributor License Agreement (CLA).

Signed-off-by: Stefan Thoene <sthoene@synopsys.com>

Co-authored-by: Elodie Chamblas <100407563+echambla@users.noreply.github.com>

Signed-off-by: pluAtAnsys <pengyuan@synopsys.com>

codecov · 2026-08-17T12:55:30Z

Codecov Report

❌ Patch coverage is 73.38129% with 37 lines in your changes missing coverage. Please review.
✅ Project coverage is 88.83%. Comparing base (ed0bc15) to head (d581c1f).

Files with missing lines	Patch %	Lines
src/ansys/speos/core/kernel/sensor_template_v2.py	50.00%	20 Missing ⚠️
src/ansys/speos/core/kernel/client.py	42.85%	8 Missing ⚠️
src/ansys/speos/core/sensor.py	89.47%	8 Missing ⚠️
src/ansys/speos/core/kernel/scene.py	66.66%	1 Missing ⚠️

Additional details and impacted files

@@                        Coverage Diff                         @@
##           feat/sensor-template-migration    #1102      +/-   ##
==================================================================
- Coverage                           89.10%   88.83%   -0.27%     
==================================================================
  Files                                  47       48       +1     
  Lines                               11631    11729      +98     
==================================================================
+ Hits                                10364    10420      +56     
- Misses                               1267     1309      +42

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

echambla · 2026-08-25T12:44:51Z

+        """
+        if not cls._supports_template_v2:
+            return False
+        return server_version_checker.is_version_supported(*cls._SENSOR_TEMPLATE_V2_MIN_VERSION)


It seems _SENSOR_TEMPLATE_V2_MIN_VERSION is not used somewhere else.
Maybe use here directly (2027, 1, 0)

And remove _SENSOR_TEMPLATE_V2_MIN_VERSION declaration

echambla · 2026-08-25T12:54:17Z

+                self._sensor_template_version = (
+                    2 if isinstance(self.sensor_template_link, SensorTemplateLinkV2) else 1
+                )
+            self._sensor_template = self._new_sensor_template(name, description, metadata)


I think this line is useless.
Usually the _sensor_template and _sensor_instance are filled thanks to the reset() call just after
(see comment)

echambla · 2026-08-25T13:01:27Z

+        return ProtoSensorTemplate(name=name, description=description, metadata=metadata)
+
+    @property
+    def sensor_template_version(self) -> int:


Is a public property useful here?
As the sensor template version is something we want to hide from core user.

I agree, that can be internal property

echambla · 2026-08-25T13:06:11Z

        ----------
-        wavelengths_range : ansys.api.speos.sensor.v1.common_pb2.WavelengthsRange
+        wavelengths_range : Union[\
+        ansys.api.speos.sensor.v1.common_pb2.WavelengthsRange, \


Missing ansys.api.speos.sensor.v1.sensor_pb2.SensorTemplate.Irradiance3D.TypeColorimetric

echambla · 2026-08-25T13:07:20Z

Missing sensor_v2_pb2.SensorTemplate.WavelengthsRange

echambla · 2026-08-25T13:39:44Z

-            self.sensor_template_link = self._project.client.sensor_templates().create(
-                message=self._sensor_template
-            )
+            if self._sensor_template_version == 2:


I am doubting if we really need self._sensor_template_version
Because instead we can just check type of self._sensor_template

Avoiding information redundancy is a way to avoid discrepancies.

echambla · 2026-08-25T14:03:02Z

+        ansys.api.speos.sensor.v2.sensor_pb2.SensorTemplate.Irradiance]
+            Protobuf sub-message holding the irradiance sensor template definition.
+        """
+        if self._sensor_template_version == 2:


instead can check type of self._sensor_template
so that we can get rid of self._sensor_template_version

echambla · 2026-08-25T14:03:52Z

+        str
+            Name of the protobuf field for the sensor template version in use.
+        """
+        if self._sensor_template_version == 2:


instead can check type of self._sensor_template
so that we can get rid of self._sensor_template_version

echambla · 2026-08-25T14:14:32Z

+            One of ``"planar"``, ``"radial"``, ``"hemispherical"``, ``"cylindrical"``,
+            ``"semi_cylindrical"``.
+        """
+        if self._sensor_template_version == 2:


instead can check type of self._sensor_template
so that we can get rid of self._sensor_template_version

echambla · 2026-08-25T14:16:11Z

+        bool
+            ``True`` if the integration type is the one currently set.
+        """
+        if self._sensor_template_version == 2:


instead can check type of self._sensor_template
so that we can get rid of self._sensor_template_version

StefanThoene and others added 16 commits August 5, 2026 13:54

template v2 implementation

b6731c5

Signed-off-by: Stefan Thoene <sthoene@synopsys.com>

template v2 tests

b2ceb9b

Signed-off-by: Stefan Thoene <sthoene@synopsys.com>

remove sensor changes

3733826

Signed-off-by: Stefan Thoene <sthoene@synopsys.com>

add scene load to use v1 template

b99adcd

Signed-off-by: Stefan Thoene <sthoene@synopsys.com>

chore: adding changelog file 1085.added.md [dependabot-skip]

47b1915

Merge branch 'main' into copilot/issue-1068-implementation-plan

9ae9626

switch dependency

f73355d

Signed-off-by: Stefan Thoene <sthoene@synopsys.com>

update UV lock

d85d0b0

Signed-off-by: Stefan Thoene <sthoene@synopsys.com>

fix sensor backwards compatibility

e8d7146

Signed-off-by: Stefan Thoene <sthoene@synopsys.com>

fix unit tests

455c875

Signed-off-by: Stefan Thoene <sthoene@synopsys.com>

allow dev versions

44e34f8

Signed-off-by: Stefan Thoene <sthoene@synopsys.com>

add additional test

dd5d805

Signed-off-by: Stefan Thoene <sthoene@synopsys.com>

Update tests/core/test_proto_message_utils.py

e93aa6d

Co-authored-by: Elodie Chamblas <100407563+echambla@users.noreply.github.com>

Apply suggestions from code review

83a152c

Co-authored-by: Elodie Chamblas <100407563+echambla@users.noreply.github.com>

core - improve version checker and add unit test

6d05472

sensor v2 implements

1f2616e

Signed-off-by: pluAtAnsys <pengyuan@synopsys.com>

pluAtAnsys requested review from StefanThoene, echambla, etiennearnal and jomadec as code owners August 17, 2026 12:45

pluAtAnsys self-assigned this Aug 17, 2026

github-actions Bot added maintenance Package and maintenance related testing Anything related to tests labels Aug 17, 2026

pluAtAnsys linked an issue Aug 17, 2026 that may be closed by this pull request

Migrate SensorIrradiance to support sensor template v1 and v2 #1089

Open

pluAtAnsys changed the title ~~Copilot/1068~~ feat: core implementation irrad sensor v2 Aug 17, 2026

chore: adding changelog file 1102.added.md [dependabot-skip]

d581c1f

echambla reviewed Aug 25, 2026

View reviewed changes

review - ECS

7bb95e6

Navigation Menu

Uh oh!

feat: core implementation irrad sensor v2 - #1102

feat: core implementation irrad sensor v2#1102
pluAtAnsys wants to merge 18 commits into
feat/sensor-template-migrationfrom
copilot/1068

pluAtAnsys commented Aug 17, 2026 •

edited

Loading

Uh oh!

codecov Bot commented Aug 17, 2026

Uh oh!

echambla Aug 25, 2026 •

edited

Loading

Uh oh!

echambla Aug 25, 2026

Uh oh!

echambla Aug 25, 2026

Uh oh!

pluAtAnsys Aug 25, 2026

Uh oh!

echambla Aug 25, 2026 •

edited

Loading

Uh oh!

echambla Aug 25, 2026

Uh oh!

echambla Aug 25, 2026 •

edited

Loading

Uh oh!

echambla Aug 25, 2026

Uh oh!

echambla Aug 25, 2026

Uh oh!

echambla Aug 25, 2026

Uh oh!

echambla Aug 25, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Uh oh!

Conversation

pluAtAnsys commented Aug 17, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Issue linked

Checklist

Uh oh!

codecov Bot commented Aug 17, 2026

Codecov Report

Uh oh!

echambla Aug 25, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

echambla Aug 25, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

echambla Aug 25, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

pluAtAnsys commented Aug 17, 2026 •

edited

Loading

echambla Aug 25, 2026 •

edited

Loading

echambla Aug 25, 2026 •

edited

Loading

echambla Aug 25, 2026 •

edited

Loading