FEAT: Perceive EM class

doc/changelog.d/6259.added.md

@@ -0,0 +1 @@
+Perceive em class

doc/source/Resources/pyaedt_settings.yaml

@@ -126,3 +126,7 @@ general:
   block_figure_plot: false
   # Skip license check during Desktop initialization
   skip_license_check: true
+
+perceive_em:
+  # Perceive EM API
+  perceive_em_api_path: null

pyproject.toml

@@ -128,7 +128,11 @@ examples = [
     "plotly>=6.0,<6.2",
     "scikit-rf>=0.30.0,<1.8",
 ]
-
+perceive_em = [
+    "matplotlib>=3.5.0,<3.11",
+    "numpy==1.26.4",
+    "imageio-ffmpeg"
+]
 [tool.setuptools.dynamic]
 version = {attr = "ansys.aedt.core.__version__"}
 

src/ansys/aedt/core/generic/settings.py

@@ -102,6 +102,8 @@
     "remote_rpc_session_temp_folder",
     "block_figure_plot",
     "skip_license_check",
+    "perceive_em_api_path",
+    "perceive_em_license_client_path",
 ]
 ALLOWED_AEDT_ENV_VAR_SETTINGS = [
     "ANSYSEM_FEATURE_F335896_MECHANICAL_STRUCTURAL_SOLN_TYPE_ENABLE",
@@ -116,6 +118,7 @@
     "ANS_MESHER_PROC_DUMP_PREPOST_BEND_SM3",
     "ANS_NODEPCHECK",
 ]
+ALLOWED_PERCEIVEEM_SETTINGS = ["perceive_em_api_path", "licensingclient_path"]
 
 
 def generate_log_filename():
@@ -214,6 +217,9 @@
         self.__time_tick = time.time()
         self.__pyaedt_server_path = ""
         self.__block_figure_plot = False
+        # Perceive EM settings
+        self.__perceive_em_api_path = None
+        self.__perceive_em_license_client_path = None
 
         # Load local settings if YAML configuration file exists.
         pyaedt_settings_path = os.environ.get("PYAEDT_LOCAL_SETTINGS_PATH", "")
@@ -785,6 +791,26 @@
     def skip_license_check(self, value):
         self.__skip_license_check = value
 
+    # ##################################### Perceive EM properties ####################################
+
+    @property
+    def perceive_em_api_path(self):
+        """Perceive EM API path."""
+        return self.__perceive_em_api_path
+
+    @perceive_em_api_path.setter
+    def perceive_em_api_path(self, value: str):
+        self.__perceive_em_api_path = value
+
+    @property
+    def perceive_em_license_client_path(self):
+        """Perceive EM license client path."""
+        return self.__perceive_em_license_client_path
+
+    @perceive_em_license_client_path.setter
+    def perceive_em_license_client_path(self, value: str):
+        self.__perceive_em_license_client_path = value
+
     def load_yaml_configuration(self, path: str, raise_on_wrong_key: bool = False):
         """Update default settings from a YAML configuration file."""
         import yaml

src/ansys/aedt/core/internal/aedt_versions.py

@@ -49,6 +49,13 @@
         self._current_student_version = None
         self._latest_version = None
 
+        # Perceive EM
+        self._list_installed_perceive_em = None
+        self._installed_perceive_em_versions = None
+        self._stable_perceive_em_versions = None
+        self._current_perceive_em_version = None
+        self._latest_perceive_em_version = None
+
     @property
     def list_installed_ansysem(self):
         """Return a list of installed AEDT versions on ``ANSYSEM_ROOT``.
@@ -69,6 +76,23 @@
             self._list_installed_ansysem = version_list
         return self._list_installed_ansysem
 
+    @property
+    def list_installed_perceive_em(self):
+        """Return a list of installed Perceive EM versions on ``ANSYSEM_PERCEIVE_EM_ROOT``.
+
+        The list is ordered: first normal versions, then client versions, finally student versions."""
+        if self._list_installed_perceive_em is None:
+            perceive_em_env_var_prefix = "ANSYSEM_PERCEIVE_EM_ROOT"
+            version_list = sorted([x for x in os.environ if x.startswith(perceive_em_env_var_prefix)], reverse=True)
+
+            if not version_list:
+                warnings.warn(
+                    "No installed versions of Perceive EM are found in the system environment variables"
+                    " ``ANSYSEM_PERCEIVE_EM_ROOTxxx``."
+                )
+            self._list_installed_perceive_em = version_list
+        return self._list_installed_perceive_em
+
     @property
     def installed_versions(self):
         """Get the installed AEDT versions.
@@ -113,6 +137,28 @@
             self._installed_versions = return_dict
         return self._installed_versions
 
+    @property
+    def installed_perceive_em_versions(self):
+        """Get the installed Perceive EM versions.
+
+        This method returns a dictionary, with the version as the key and installation path
+        as the value."""
+        if self._installed_perceive_em_versions is None:
+            return_dict = {}
+            # version_list is ordered: first normal versions, then client versions, finally student versions
+            version_list = self.list_installed_perceive_em
+            for version_env_var in version_list:
+                try:
+                    version = int(version_env_var[-3:-1])
+                    release = int(version_env_var[-1])
+                    v_key = f"20{version}.{release}"
+                    return_dict[v_key] = os.environ[version_env_var]
+                except Exception:  # pragma: no cover
+                    if settings.logger:
+                        settings.logger.debug(f"Failed to parse version and release from {version_env_var}")
+            self._installed_perceive_em_versions = return_dict
+        return self._installed_perceive_em_versions
+
     @property
     def stable_versions(self):
         """Get all stable versions installed on the system"""
@@ -125,6 +171,18 @@
                 self._stable_versions = []
         return self._stable_versions
 
+    @property
+    def stable_perceive_em_versions(self):
+        """Get all stable versions installed on the system"""
+        if self._stable_perceive_em_versions is None:
+            try:
+                self._stable_perceive_em_versions = [
+                    v for v in self.installed_perceive_em_versions if v <= str(CURRENT_STABLE_AEDT_VERSION)
+                ]
+            except (NameError, IndexError, ValueError):
+                self._stable_perceive_em_versions = []
+        return self._stable_perceive_em_versions
+
     @property
     def current_version(self):
         """Get the most recent stable AEDT version."""
@@ -135,6 +193,16 @@
                 self._current_version = ""
         return self._current_version
 
+    @property
+    def current_perceive_em_version(self):
+        """Get the most recent stable Perceive EM version."""
+        if self._current_perceive_em_version is None:
+            if self.stable_perceive_em_versions:
+                self._current_perceive_em_version = self.stable_versions[0]
+            else:
+                self._current_perceive_em_version = ""
+        return self._current_perceive_em_version
+
     @property
     def current_student_version(self):
         """Get the current stable AEDT student version."""
@@ -156,6 +224,16 @@
                 self._latest_version = ""
         return self._latest_version
 
+    @property
+    def latest_perceive_em_version(self):
+        """Get the latest AEDT version, even if it is pre-release."""
+        if self._latest_perceive_em_version is None:
+            try:
+                self._latest_perceive_em_version = list(self.installed_perceive_em_versions.keys())[0]
+            except (NameError, IndexError):
+                self._latest_perceive_em_version = ""
+        return self._latest_perceive_em_version
+
     @staticmethod
     def get_version_env_variable(version_id):
         """Get the environment variable for the AEDT version.

src/ansys/aedt/core/perceive_em/__init__.py

@@ -0,0 +1,29 @@
+# ruff: noqa: E402
+
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 2021 - 2025 ANSYS, Inc. and/or its affiliates.
+# SPDX-License-Identifier: MIT
+#
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
+from pathlib import Path
+
+MISC_PATH = Path(__file__).parent / "misc"

src/ansys/aedt/core/perceive_em/core/__init__.py

@@ -0,0 +1,25 @@
+# ruff: noqa: E402
+
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 2021 - 2025 ANSYS, Inc. and/or its affiliates.
+# SPDX-License-Identifier: MIT
+#
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.