ansys-pyensight-core 0.11.0__py3-none-any.whl

ansys/pyensight/core/__init__.py

@@ -0,0 +1,41 @@
+# Copyright (C) 2022 - 2026 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.
+
+try:
+    import importlib.metadata as importlib_metadata  # type: ignore
+except ModuleNotFoundError:  # pragma: no cover
+    import importlib_metadata  # type: ignore
+__version__ = importlib_metadata.version(__name__.replace(".", "-"))
+
+VERSION = __version__
+DEFAULT_ANSYS_VERSION = "251"
+
+# Ansys version number that this release is associated with
+__ansys_version__ = DEFAULT_ANSYS_VERSION
+__ansys_version_str__ = f"{2000+(int(__ansys_version__) // 10)} R{int(__ansys_version__) % 10}"
+
+from ansys.pyensight.core.dockerlauncher import DockerLauncher
+from ansys.pyensight.core.launch_ensight import launch_ensight, launch_libuserd
+from ansys.pyensight.core.launcher import Launcher
+from ansys.pyensight.core.listobj import ensobjlist
+from ansys.pyensight.core.locallauncher import LocalLauncher
+from ansys.pyensight.core.session import Session

ansys/pyensight/core/common.py

@@ -0,0 +1,341 @@
+# Copyright (C) 2022 - 2026 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.
+
+""" This module provides a list of common utilities shared between different PyEnSight modules."""
+
+import os
+import random
+import re
+import socket
+import time
+from typing import TYPE_CHECKING, Any, Dict, List, Optional, Tuple
+
+from ansys.pyensight.core import enshell_grpc
+import urllib3
+
+try:
+    from simple_upload_server.client import Client
+
+    simple_upload_server_is_available = True  # pragma: no cover
+except Exception:
+    simple_upload_server_is_available = False
+
+if TYPE_CHECKING:
+    from docker import DockerClient
+
+GRPC_VERSIONS = ["2025 R2.3", "2025 R1.4", "2024 R2.5"]
+GRPC_WARNING_MESSAGE = "The EnSight version being used uses an insecure gRPC connection."
+GRPC_WARNING_MESSAGE += "Consider upgrading to a version higher than 2025 R2.3, or "
+GRPC_WARNING_MESSAGE += "2024 R2.5 or higher service packs, or 2025 R1.4 or higher service packs."
+
+
+def find_unused_ports(count: int, avoid: Optional[List[int]] = None) -> Optional[List[int]]:
+    """Find "count" unused ports on the host system
+
+    A port is considered unused if it does not respond to a "connect" attempt.  Walk
+    the ports from 'start' to 'end' looking for unused ports and avoiding any ports
+    in the 'avoid' list.  Stop once the desired number of ports have been
+    found.  If an insufficient number of ports were found, return None.
+
+    Parameters
+    ----------
+    count: int :
+        Number of unused ports to find
+    avoid: Optional[List[int]] :
+        An optional list of ports not to check
+
+    Returns
+    -------
+        The detected ports or None on failure
+
+    """
+    if avoid is None:
+        avoid = []
+    ports = list()
+
+    # pick a starting port number
+    start = random.randint(1024, 64000)
+    # We will scan for 65530 ports unless end is specified
+    port_mod = 65530
+    end = start + port_mod - 1
+    # walk the "virtual" port range
+    for base_port in range(start, end + 1):
+        # Map to physical port range
+        # There have been some issues with 65534+ so we stop at 65530
+        port = base_port % port_mod
+        # port 0 is special
+        if port == 0:  # pragma: no cover
+            continue  # pragma: no cover
+        # avoid admin ports
+        if port < 1024:  # pragma: no cover
+            continue  # pragma: no cover
+        # are we supposed to skip this one?
+        if port in avoid:  # pragma: no cover
+            continue  # pragma: no cover
+        # is anyone listening?
+        sock = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
+        result = sock.connect_ex(("127.0.0.1", port))
+        if result != 0:
+            ports.append(port)
+        else:
+            sock.close()  # pragma: no cover
+        if len(ports) >= count:
+            return ports
+    # in case we failed...
+    if len(ports) < count:  # pragma: no cover
+        return None  # pragma: no cover
+    return ports  # pragma: no cover
+
+
+def get_host_port(uri: str) -> Tuple[str, int]:
+    """Get the host port for the input uri
+
+    Parameters
+    ----------
+
+    uri: str
+        The Uri to inspect
+
+    Returns
+    -------
+    (tuple):
+        A tuple containing the host and the port of the input uri
+    """
+    parse_results = urllib3.util.parse_url(uri)
+    port = (
+        parse_results.port
+        if parse_results.port
+        else (443 if re.search(r"^https|wss$", parse_results.scheme) else None)
+    )
+    return (parse_results.host, port)
+
+
+def get_file_service(pim_instance: Any) -> Optional[Any]:  # pragma: no cover
+    """Get the file service object for the input pim instance.
+
+    Parameters
+    ----------
+
+    pim_instance:
+        the PIM instance to get the service from.
+
+    Returns
+    -------
+
+    pim_file_service:
+        the PIM file service object
+    """
+    if simple_upload_server_is_available is False:
+        return None
+    if pim_instance is None:
+        return None
+
+    if "http-simple-upload-server" in pim_instance.services:
+        pim_file_service = Client(
+            token="token",
+            url=pim_instance.services["http-simple-upload-server"].uri,
+            headers=pim_instance.services["http-simple-upload-server"].headers,
+        )
+        return pim_file_service
+    return None
+
+
+def populate_service_host_port(  # pragma: no cover
+    pim_instance: Any, service_host_port: Dict[str, Tuple[str, int]], webui: bool = False
+) -> Dict[str, Tuple[str, int]]:
+    """Populate the service host port dictionary with the services available in the PIM instance.
+
+    Parameters
+    ----------
+    pim_instance:
+        the PIM instance to get the servicea from.
+    service_host_port: dict
+        the dictionary to be updated with the services from the PIM instance
+    webui: bool
+        if True retrieve also the webUI service
+
+    Returns
+    -------
+    service_host_port: dict
+        the dictionary updated with the services from the PIM instance
+    """
+    if not set(("grpc_private", "http", "ws")).issubset(pim_instance.services):
+        raise RuntimeError(
+            "If channel is specified, the PIM instance must have a list of length 3 "
+            + "containing the appropriate service URIs. It does not."
+        )
+    service_host_port["grpc_private"] = get_host_port(pim_instance.services["grpc_private"].uri)
+    service_host_port["http"] = get_host_port(pim_instance.services["http"].uri)
+    service_host_port["ws"] = get_host_port(pim_instance.services["ws"].uri)
+    service_host_port["grpc"] = ("127.0.0.1", -1)
+    if webui:
+        service_host_port["webui"] = get_host_port(pim_instance.services["webui"].uri)
+    return service_host_port
+
+
+def launch_enshell_interface(
+    enshell_grpc_channel: Any,
+    grpc_port: int,
+    timeout: float,
+    secret_key: str,
+    grpc_use_tcp_sockets: bool = False,
+    grpc_allow_network_connections: bool = False,
+    grpc_disable_tls: bool = False,
+    grpc_uds_pathname: Optional[str] = None,
+    disable_grpc_options: bool = False,
+) -> enshell_grpc.EnShellGRPC:
+    """Launch the EnShell gRPC Interface.
+
+    Parameters
+    ----------
+    enshell_grpc_channel:
+        An eventual gRPC channel already available, like in the PIM case
+    grpc_port: int
+        the gRPC port to connect to
+    timeout: float
+        a timeout to wait for the gRPC connection
+    grpc_use_tcp_sockets: bool
+        If using gRPC, and if True, then allow TCP Socket based connections
+        instead of only local connections.
+    grpc_allow_network_connections: bool
+        If using gRPC and using TCP Socket based connections, listen on all networks.
+    grpc_disable_tls: bool
+        If using gRPC and using TCP Socket based connections, disable TLS.
+    grpc_uds_pathname: bool
+        If using gRPC and using Unix Domain Socket based connections, explicitly
+        set the pathname to the shared UDS file instead of using the default.
+    disable_grpc_options: bool, optional
+        Whether to disable the gRPC options check, and allow to run older
+        versions of EnSight
+
+    Returns
+    -------
+    enshell: enshell_grpc.EnShellGRPC
+        the enshell gRPC interface
+
+    WARNING:
+    Overriding the default values for these options: grpc_use_tcp_sockets, grpc_allow_network_connections,
+    and grpc_disable_tls
+    can possibly permit control of this computer and any data which resides on it.
+    Modification of this configuration is not recommended.  Please see the
+    documentation for your installed product for additional information.
+    """
+    if enshell_grpc_channel:  # pragma: no cover
+        enshell = enshell_grpc.EnShellGRPC(
+            grpc_use_tcp_sockets=grpc_use_tcp_sockets,
+            grpc_allow_network_connections=grpc_allow_network_connections,
+            grpc_disable_tls=grpc_disable_tls,
+            grpc_uds_pathname=grpc_uds_pathname,
+            disable_grpc_options=disable_grpc_options,
+        )  # pragma: no cover
+        # If disable_grpc_options is True, it means that in the launcher
+        # the ensight version was checked and it hasn't got the new
+        # grpc options. This means that enshell doesn't accept a string
+        # as security token
+        if not disable_grpc_options:
+            enshell.security_token = secret_key
+        enshell.connect_existing_channel(enshell_grpc_channel)  # pragma: no cover
+    else:
+        enshell = enshell_grpc.EnShellGRPC(
+            port=grpc_port,
+            grpc_use_tcp_sockets=grpc_use_tcp_sockets,
+            grpc_allow_network_connections=grpc_allow_network_connections,
+            grpc_disable_tls=grpc_disable_tls,
+            grpc_uds_pathname=grpc_uds_pathname,
+            disable_grpc_options=disable_grpc_options,
+        )
+        # If disable_grpc_options is True, it means that in the launcher
+        # the ensight version was checked and it hasn't got the new
+        # grpc options. This means that enshell doesn't accept a string
+        # as security token
+        if not disable_grpc_options:
+            enshell.security_token = secret_key
+        time_start = time.time()
+        while time.time() - time_start < timeout:  # pragma: no cover
+            if enshell.is_connected():
+                break
+            try:
+                enshell.connect(timeout=timeout)
+            except OSError:  # pragma: no cover
+                pass  # pragma: no cover
+    return enshell
+
+
+def pull_image(docker_client: "DockerClient", image_name: str) -> None:
+    """Pull the input docker image using the input Docker Client
+
+    Parameters
+    ----------
+    docker_client: DockerClient
+        the current DockerClient to pull the image with
+    image_name: str
+        the image to pull
+    """
+    try:
+        if docker_client is not None:  # pragma: no cover
+            docker_client.images.pull(image_name)
+    except Exception:
+        raise RuntimeError(f"Can't pull Docker image: {image_name}")
+
+
+def _is_within_directory(directory, target):
+    """Check if target is inside of the input directory."""
+    abs_directory = os.path.abspath(directory)
+    abs_target = os.path.abspath(target)
+    return os.path.commonprefix([abs_directory, abs_target]) == abs_directory
+
+
+def safe_extract(tar, path=".", members=None, *, numeric_owner=False):
+    """Utility to check tar extraction to avoid bandit check issue."""
+    for member in tar.getmembers():
+        member_path = os.path.join(path, member.name)
+        if not _is_within_directory(path, member_path):
+            raise Exception("Attempted Path Traversal in Tar File")
+    tar.extractall(path, members, numeric_owner=numeric_owner)
+
+
+def grpc_version_check(internal_version, ensight_full_version):
+    """Check if the gRPC security options apply to the EnSight install."""
+    if int(internal_version) < 242:
+        return False
+    # From 261 onward always available
+    if int(internal_version) >= 261:
+        return True
+    # Exactly matches one of the service pack that introduced the changes
+    if ensight_full_version in GRPC_VERSIONS:
+        return True
+    split_version = ensight_full_version.split(" ")
+    year = split_version[0]
+    # Not a service pack
+    if len(split_version[1].split(".")) == 1:
+        return False
+    r_version = split_version[1].split(".")[0]
+    dot_version = int(split_version[1].split(".")[1])
+    # Check service pack version
+    if year == "2024" and dot_version < 5:
+        return False
+    if year == "2025":
+        if r_version == "R1" and dot_version < 4:
+            return False
+        if r_version == "R2" and dot_version < 3:
+            return False
+    return True

ansys/pyensight/core/deep_pixel_view.html

@@ -0,0 +1,98 @@
+<!DOCTYPE html>
+<html lang="en">
+	 <head>
+		 <link rel="stylesheet" type="text/css" href="/bootstrap.min.cssOPTIONAL_QUERY"/>
+
+		 <script src='/jqueryJQUERY_VERSION.min.jsOPTIONAL_QUERY'></script>
+		 <script src='/geotiff.jsOPTIONAL_QUERY'></script>
+		 <script src='/geotiff_nexus.jsOPTIONAL_QUERY'></script>
+		 <script src="/bootstrap.min.jsOPTIONAL_QUERY"></script>
+
+		 <script>
+			function updatepick_ITEMID(e) {
+				let x = e.offsetX;
+				let y = e.offsetY;
+				let image_elem = document.getElementById('nexus_image_ITEMID');
+				const origWidth = image_elem.nexus_width;
+				const origHeight = image_elem.nexus_height;
+				x = (x * (origWidth / image_elem.width)) | 0;
+				y = (y * (origHeight / image_elem.height)) | 0;
+				x = x >= origWidth ? origWidth - 1 : x;
+				x = x < 0 ? 0 : x;
+				y = y >= origHeight ? origHeight - 1 : y;
+				y = y < 0 ? 0 : y;
+				let idx = y * origWidth + x;
+
+				let probeResult = "";
+				if ('nexus_pick_buffer' in image_elem) {
+					let partid = image_elem.nexus_pick_buffer[idx * 4] + 256 * image_elem.nexus_pick_buffer[idx * 4 + 1];
+					if (partid in image_elem.nexus_metadata) {
+						let partinfo = image_elem.nexus_metadata[partid];
+						probeResult += " Part: '" + partinfo.name + "'";
+						if ('variable' in partinfo) {
+							if ('nexus_var_buffer' in image_elem) {
+								let vardata = image_elem.nexus_var_buffer[idx];
+								let varinfo = image_elem.nexus_varinfo[partinfo.variable];
+								probeResult += " Var: '" + varinfo.name + "' " + vardata.toExponential(5);
+								if (varinfo.unit_label.length) {
+									probeResult += " [" + varinfo.unit_label + "]";
+								}
+							}
+						}
+					} else {
+						probeResult += "Part: None";
+					}
+				}
+
+				let probeDisplay = $('#probe_display_ITEMID');
+				// dispose first so it doesn't use tooltips created previously
+				probeDisplay.tooltip('dispose');
+				probeDisplay.tooltip('show');
+				// display coordinates
+				$("#probe_xy_ITEMID").text(`${x}, ${y}`);
+				// display values
+				$("#probe_result_ITEMID").html(probeResult);
+			}
+
+			function clearpick_ITEMID() {
+				let probeDisplay = $('#probe_display_ITEMID');
+				// hide and dispose existing tooltips
+				probeDisplay.tooltip('hide');
+				probeDisplay.tooltip('dispose');
+			}
+
+			async function tiff_image_ITEMID_loader() {
+				const response = await fetch("TIFF_URL");
+				const arrayBuffer = await response.arrayBuffer();
+				const tiff_promise_ITEMID = GeoTIFF.fromArrayBuffer(arrayBuffer);
+				tiff_promise_ITEMID.then(nexus_image_load_tiff_image.bind(null, "nexus_image_ITEMID"), nexus_image_general_error);
+			}
+
+			tiff_image_ITEMID_loader();
+
+		</script>
+	</head>
+	<body style="margin:0px;padding:0px;">
+		<div style="margin: 0 auto; display:flex; justify-content:center;">
+			<!-- tooltip parent for img --->
+			<div id="probe_display_ITEMID"
+				 data-BS_PREFIXtoggle="tooltip"
+				 data-BS_PREFIXplacement="bottom"
+				 data-BS_PREFIXfallbackPlacement="['top', 'right']"
+				 data-BS_PREFIXhtml="true"
+				 data-BS_PREFIXcontainer="body"
+				 data-BS_PREFIXboundary="viewport"
+				 data-BS_PREFIXanimation="false"
+				 data-BS_PREFIXtrigger="manual"
+				 data-BS_PREFIXtitle='<span class="f-1r">
+											<span>X, Y : <span id="probe_xy_ITEMID">0, 0</span></span>
+											<br>
+											<span id="probe_result_ITEMID"></span>
+										</span>'
+			>
+				<img id="nexus_image_ITEMID" onmousemove="updatepick_ITEMID(event)"
+					 onmouseout="clearpick_ITEMID()" class="img-fluid"><br>
+			</div>
+		</div>
+	</body>
+</html>