PyPI - ansys-pyensight-core - Versions diffs - 0.6.1__py3-none-any.whl → 0.6.2__py3-none-any.whl - Mend

ansys-pyensight-core 0.6.1py3-none-any.whl → 0.6.2py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Potentially problematic release.

This version of ansys-pyensight-core might be problematic. Click here for more details.

Files changed (11) hide show

ansys/pyensight/core/deep_pixel_view.html CHANGED Viewed

@@ -1,12 +1,12 @@
 <!DOCTYPE html>
 <html lang="en">
 	 <head>
-		 <link rel="stylesheet" type="text/css" href="/bootstrap.min.css"/>
+		 <link rel="stylesheet" type="text/css" href="/bootstrap.min.cssOPTIONAL_QUERY"/>
-		 <script src='/jquery-3.4.1.min.js'></script>
-		 <script src='/geotiff.js'></script>
-		 <script src='/geotiff_nexus.js'></script>
-		 <script src="/bootstrap.min.js"></script>
+		 <script src='/jquery-3.4.1.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) {

ansys/pyensight/core/dockerlauncher.py CHANGED Viewed

@@ -16,6 +16,7 @@ Examples:
 """
 import logging
 import os.path
+import re
 import subprocess
 import time
 from typing import Any, Dict, Optional
@@ -160,6 +161,11 @@ class DockerLauncher(Launcher):
             self._service_host_port["grpc"] = ("127.0.0.1", -1)
             # attach to the file service if available
             self._get_file_service()
+            # if using PIM, we have a query parameter to append to http requests
+            if self._pim_instance is not None:
+                d = {"instance_name": self._pim_instance.name}
+                self._add_query_parameters(d)
+            #
             return
         # EnShell gRPC port, EnSight gRPC port, HTTP port, WSS port
@@ -217,6 +223,31 @@ class DockerLauncher(Launcher):
         except Exception:
             raise RuntimeError(f"Can't pull Docker image: {self._image_name}")
+    def _get_container_env(self) -> Dict:
+        # Create the environmental variables
+        # Environment to pass into the container
+        container_env = {
+            "ENSIGHT_SECURITY_TOKEN": self._secret_key,
+            "WEBSOCKETSERVER_SECURITY_TOKEN": self._secret_key,
+            "ENSIGHT_SESSION_TEMPDIR": self._session_directory,
+        }
+        # If for some reason, the ENSIGHT_ANSYS_LAUNCH is set previously,
+        # honor that value, otherwise set it to "pyensight".  This allows
+        # for an environmental setup to set the value to something else
+        # (e.g. their "app").
+        if "ENSIGHT_ANSYS_LAUNCH" not in os.environ:
+            container_env["ENSIGHT_ANSYS_LAUNCH"] = "container"
+        else:
+            container_env["ENSIGHT_ANSYS_LAUNCH"] = os.environ["ENSIGHT_ANSYS_LAUNCH"]
+        if self._pim_instance is None:
+            container_env["ANSYSLMD_LICENSE_FILE"] = os.environ["ANSYSLMD_LICENSE_FILE"]
+            if "ENSIGHT_ANSYS_APIP_CONFIG" in os.environ:
+                container_env["ENSIGHT_ANSYS_APIP_CONFIG"] = os.environ["ENSIGHT_ANSYS_APIP_CONFIG"]
+        return container_env
     def start(self) -> "Session":
         """Start EnShell by running a local Docker EnSight image.
@@ -245,27 +276,8 @@ class DockerLauncher(Launcher):
         # initially running EnShell over the first gRPC port. Then launch EnSight
         # and other apps.
-        # Create the environmental variables
-        local_env = os.environ.copy()
-        local_env["ENSIGHT_SECURITY_TOKEN"] = self._secret_key
-        local_env["WEBSOCKETSERVER_SECURITY_TOKEN"] = self._secret_key
-        # If for some reason, the ENSIGHT_ANSYS_LAUNCH is set previously,
-        # honor that value, otherwise set it to "pyensight".  This allows
-        # for an environmental setup to set the value to something else
-        # (e.g. their "app").
-        if "ENSIGHT_ANSYS_LAUNCH" not in local_env:
-            local_env["ENSIGHT_ANSYS_LAUNCH"] = "container"
-        # Environment to pass into the container
-        container_env = {
-            "ENSIGHT_SECURITY_TOKEN": self._secret_key,
-            "WEBSOCKETSERVER_SECURITY_TOKEN": self._secret_key,
-            "ENSIGHT_SESSION_TEMPDIR": self._session_directory,
-            "ANSYSLMD_LICENSE_FILE": os.environ["ANSYSLMD_LICENSE_FILE"],
-            "ENSIGHT_ANSYS_LAUNCH": local_env["ENSIGHT_ANSYS_LAUNCH"],
-        }
-        if "ENSIGHT_ANSYS_APIP_CONFIG" in local_env:
-            container_env["ENSIGHT_ANSYS_APIP_CONFIG"] = local_env["ENSIGHT_ANSYS_APIP_CONFIG"]
+        # get the environment to pass to the container
+        container_env = self._get_container_env()
         # Ports to map between the host and the container
         # If we're here in the code, then we're not using PIM
@@ -452,10 +464,27 @@ class DockerLauncher(Launcher):
         use_egl = self._use_egl()
+        # get the environment to pass to the container
+        container_env_str = ""
+        if self._pim_instance is not None:
+            container_env = self._get_container_env()
+            for i in container_env.items():
+                container_env_str += f"{i[0]}={i[1]}\n"
         # Run EnSight
         ensight_env_vars = None
+        if container_env_str != "":
+            ensight_env_vars = container_env_str
         if use_egl:
-            ensight_env_vars = "LD_PRELOAD=/usr/local/lib64/libGL.so.1:/usr/local/lib64/libEGL.so.1"
+            if ensight_env_vars is None:
+                ensight_env_vars = (
+                    "LD_PRELOAD=/usr/local/lib64/libGL.so.1:/usr/local/lib64/libEGL.so.1"
+                )
+            else:
+                ensight_env_vars += (
+                    "LD_PRELOAD=/usr/local/lib64/libGL.so.1:/usr/local/lib64/libEGL.so.1"
+                )
         ensight_args = "-batch -v 3"
@@ -481,23 +510,35 @@ class DockerLauncher(Launcher):
         # Run websocketserver
         wss_cmd = "cpython /ansys_inc/v" + self._ansys_version + "/CEI/nexus"
         wss_cmd += self._ansys_version + "/nexus_launcher/websocketserver.py"
+        # websocket port - this needs to come first since we now have
+        # --add_header as a optional arg that can take an arbitrary
+        # number of optional headers.
+        wss_cmd += " " + str(self._service_host_port["ws"][1])
+        #
         wss_cmd += " --http_directory " + self._session_directory
         # http port
         wss_cmd += " --http_port " + str(self._service_host_port["http"][1])
         # vnc port
         wss_cmd += " --client_port 1999"
+        # optional PIM instance header
+        if self._pim_instance is not None:
+            # Add the PIM instance header. wss needs to return this optional
+            # header in each http response.  It's how the Ansys Lab proxy
+            # knows how to map back to this particular container's IP and port.
+            wss_cmd += " --add_header instance_name=" + self._pim_instance.name
+        # EnSight REST API
         if self._enable_rest_api:
             # grpc port
             wss_cmd += " --grpc_port " + str(self._service_host_port["grpc_private"][1])
         # EnVision sessions
         wss_cmd += " --local_session envision 5"
-        # websocket port
-        wss_cmd += " " + str(self._service_host_port["ws"][1])
+        wss_env_vars = None
+        if container_env_str != "":
+            wss_env_vars = container_env_str
         logging.debug(f"Starting WSS: {wss_cmd}\n")
-        ret = self._enshell.start_other(wss_cmd)
+        ret = self._enshell.start_other(wss_cmd, extra_env=wss_env_vars)
         if ret[0] != 0:
             self.stop()
             raise RuntimeError(f"Error starting WSS: {wss_cmd}\n")
@@ -511,11 +552,16 @@ class DockerLauncher(Launcher):
         use_sos = False
         if self._use_sos:
             use_sos = True
+        if self._pim_instance is None:
+            ws_port = self._service_host_port["ws"][1]
+        else:
+            ws_port = self._service_host_port["http"][1]
         session = ansys.pyensight.core.session.Session(
             host=self._service_host_port["grpc_private"][0],
             grpc_port=self._service_host_port["grpc_private"][1],
+            html_hostname=self._service_host_port["http"][0],
             html_port=self._service_host_port["http"][1],
-            ws_port=self._service_host_port["ws"][1],
+            ws_port=ws_port,
             install_path=None,
             secret_key=self._secret_key,
             timeout=self._timeout,
@@ -578,7 +624,12 @@ class DockerLauncher(Launcher):
     def _get_host_port(self, uri: str) -> tuple:
         parse_results = urllib3.util.parse_url(uri)
-        return (parse_results.host, parse_results.port)
+        port = (
+            parse_results.port
+            if parse_results.port
+            else (443 if re.search("^https|wss$", parse_results.scheme) else None)
+        )
+        return (parse_results.host, port)
     def _is_system_egl_capable(self) -> bool:
         """Check if the system is EGL capable.

ansys/pyensight/core/enshell_grpc.py CHANGED Viewed

@@ -357,10 +357,9 @@ class EnShellGRPC(object):
     # @brief
     #
     # @param cmd The command line
     # @return A tuple of (int, string) for (returnCode, returnString)
-    def start_other(self, cmd: str):
+    def start_other(self, cmd: str, extra_env: Optional[str] = None):
         """Tell EnShell to start a non-EnShell aware command.
         The string will be sent to EnShell via the EnShellService::run_command()
@@ -381,7 +380,10 @@ class EnShellGRPC(object):
         self.connect()
         command_string = "start_app OTHER " + cmd
-        return self.run_command(command_string)
+        if extra_env is None or extra_env == "":
+            return self.run_command(command_string)
+        else:
+            return self.run_command_with_env(command_string, extra_env)
     def cei_home(self):
         """Get the value of CEI_HOME from EnShell."""

ansys/pyensight/core/launch_ensight.py CHANGED Viewed

@@ -78,10 +78,7 @@ if pim_is_available:
             ]
         )
-        launcher = DockerLauncher(
-            channel=channel,
-            pim_instance=instance,
-        )
+        launcher = DockerLauncher(channel=channel, pim_instance=instance, **kwargs)
         return launcher.connect()

ansys/pyensight/core/launcher.py CHANGED Viewed

@@ -14,7 +14,7 @@ Examples:
 import os.path
 import platform
 import socket
-from typing import TYPE_CHECKING, List, Optional
+from typing import TYPE_CHECKING, Dict, List, Optional
 import warnings
 import requests
@@ -82,6 +82,8 @@ class Launcher:
                 self._egl_env_val = True
             else:
                 self._egl_env_val = False
+        # a dict of any optional launcher specific query parameters for URLs
+        self._query_parameters: Dict[str, str] = {}
     @property
     def session_directory(self) -> str:
@@ -266,3 +268,44 @@ class Launcher:
         """
         return platform.system() == "Windows"
+    def _get_query_parameters(self) -> Dict[str, str]:
+        """Return optional http query parameters as a dict.
+        It may be empty if there are None.
+        If query parameters exist, they should be added to any
+        http/https URL intended for the WSS web server.
+        This is used by things such as Ansys Lab.
+        Returns
+        -------
+        dict
+            query parameters that should be appended to any queries
+        """
+        return self._query_parameters
+    def _add_query_parameters(self, params: Dict[str, str]) -> None:
+        """Add query parameters supplied by params to the
+        overall dict of query parameters.
+        Parameters
+        ----------
+        params: dict :
+            query parameters to add to overall dict
+        """
+        for item, value in params.items():
+            self._query_parameters[item] = value
+    def _delete_query_parameters(self, params: List[str]) -> None:
+        """Delete query parameters supplied by params from the
+        overall dict of query parameters.
+        Parameters
+        ----------
+        params: list :
+            query parameters to delete from the overall dict
+        """
+        for item in params:
+            try:
+                del self._query_parameters[item]
+            except Exception:
+                pass

ansys/pyensight/core/renderable.py CHANGED Viewed

@@ -5,7 +5,7 @@ that can be displayed via HTML over the websocket server interface.
 """
 import os
 import shutil
-from typing import TYPE_CHECKING, Any, List, Optional, Tuple, no_type_check
+from typing import TYPE_CHECKING, Any, Dict, List, Optional, Tuple, no_type_check
 import uuid
 import webbrowser
@@ -80,6 +80,17 @@ class Renderable:
         self._aa: int = aa
         self._fps: float = fps
         self._num_frames: Optional[int] = num_frames
+        #
+        self._using_proxy = False
+        # if we're talking directly to WS, then use 'http' otherwise 'https' for the proxy
+        self._http_protocol = "http"
+        try:
+            if self._session.launcher._pim_instance is not None:
+                self._using_proxy = True
+                self._http_protocol = "https"
+        except Exception:
+            # the launcher may not be PIM aware; that's ok
+            pass
     def __repr__(self) -> str:
         name = self.__class__.__name__
@@ -100,6 +111,27 @@ class Renderable:
         name = self.__class__.__name__
         p.text(f"{name}( url='{self._url}' )")
+    def _get_query_parameters_str(self, params: Optional[Dict[str, str]] = None) -> str:
+        """Generate any optional http query parameters.
+        Return a string formatted as a URL query to tack on to the
+        beginning part of the URL.  The string may be empty if there
+        aren't any parameters.  The method takes a dict
+        of parameters, possibly empty or None, and combines it with the
+        parameters from the launcher, which also may be empty.
+        """
+        qp_dict = self._session.launcher._get_query_parameters()
+        if qp_dict is None:
+            # just in case
+            qp_dict = {}
+        if params:
+            qp_dict.update(params)
+        query_parameter_str = ""
+        symbol = "?"
+        for p in qp_dict.items():
+            query_parameter_str += f"{symbol}{p[0]}={p[1]}"
+            symbol = "&"
+        return query_parameter_str
     def _generate_filename(self, suffix: str) -> Tuple[str, str]:
         """Create session-specific files and URLs.
@@ -134,6 +166,8 @@ class Renderable:
         The URL to the file (through the session HTTP server) is
         ``http://{system}:{websocketserverhtmlport}/{session}_{guid}_{index}_{type}.html``.
+        Note that there may be optional http query parameters at the end of the URL.
         After this call, ``_url`` and ``_url_remote_pathname`` reflect these names.
         """
@@ -141,8 +175,8 @@ class Renderable:
         filename_index = self._filename_index
         remote_pathname, _ = self._generate_filename(suffix)
         simple_filename = f"{self._session.secret_key}_{self._guid}_{filename_index}{suffix}"
-        url = f"http://{self._session.hostname}:{self._session.html_port}/{simple_filename}"
-        self._url = url
+        url = f"{self._http_protocol}://{self._session.html_hostname}:{self._session.html_port}"
+        self._url = f"{url}/{simple_filename}{self._get_query_parameters_str()}"
         self._url_remote_pathname = remote_pathname
     def _save_remote_html_page(self, html: str) -> None:
@@ -265,7 +299,7 @@ class Renderable:
         """
         for filename in self._download_names:
-            url = f"http://{self._session.hostname}:{self._session.html_port}/{filename}"
+            url = f"{self._http_protocol}://{self._session.html_hostname}:{self._session.html_port}/{filename}{self._get_query_parameters_str()}"
             outpath = os.path.join(dirname, filename)
             with requests.get(url, stream=True) as r:
                 with open(outpath, "wb") as f:
@@ -302,7 +336,7 @@ class RenderableImage(Renderable):
         self._session.cmd(cmd)
         # generate HTML page with file references local to the websocket server root
         html = '<body style="margin:0px;padding:0px;">\n'
-        html += f'<img src="/{self._png_filename}">\n'
+        html += f'<img src="/{self._png_filename}{self._get_query_parameters_str()}">\n'
         html += "</body>\n"
         # refresh the remote HTML
         self._save_remote_html_page(html)
@@ -330,6 +364,9 @@ class RenderableDeepPixel(Renderable):
         an iframe reference.
         """
         # save the (deep) image file
+        # get the optional query parameters which may be an empty string
+        # needed for proxy servers like ansys lab
+        optional_query = self._get_query_parameters_str()
         w, h = self._default_size(1920, 1080)
         deep = f",num_samples={self._aa},enhanced=1"
         cmd = f'ensight.render({w},{h}{deep}).save(r"""{self._tif_pathname}""")'
@@ -347,10 +384,12 @@ class RenderableDeepPixel(Renderable):
         name += "'website', 'static', 'website', 'content', 'bootstrap.min.css')"
         cmd += f'shutil.copy({name}, r"""{self._session.launcher.session_directory}""")\n'
         self._session.cmd(cmd, do_eval=False)
+        url = f"{self._http_protocol}://{self._session.html_hostname}:{self._session.html_port}"
+        tiff_url = f"{url}/{self._tif_filename}{optional_query}"
         # replace some bits in the HTML
-        tiff_url = f"http://{self._session.hostname}:{self._session.html_port}/{self._tif_filename}"
         html = html.replace("TIFF_URL", tiff_url)
         html = html.replace("ITEMID", self._guid)
+        html = html.replace("OPTIONAL_QUERY", optional_query)
         # refresh the remote HTML
         self._save_remote_html_page(html)
         super().update()
@@ -425,7 +464,7 @@ class RenderableMP4(Renderable):
         # generate HTML page with file references local to the websocket server root
         html = '<body style="margin:0px;padding:0px;">\n'
         html += f'<video width="{w}" height="{h}" controls>\n'
-        html += f'    <source src="/{self._mp4_filename}" type="video/mp4" />\n'
+        html += f'    <source src="/{self._mp4_filename}{self._get_query_parameters_str()}" type="video/mp4" />\n'
         html += "</video>\n"
         html += "</body>\n"
@@ -471,8 +510,15 @@ class RenderableWebGL(Renderable):
         # Save the file
         self._session.ensight.savegeom.save_geometric_entities(self._avz_pathname)
         # generate HTML page with file references local to the websocket server root
-        html = "<script src='/ansys/nexus/viewer-loader.js'></script>\n"
-        html += f"<ansys-nexus-viewer src='/{self._avz_filename}'></ansys-nexus-viewer>\n"
+        if self._using_proxy:
+            # if using pim we get the static content from the front end and not
+            # where ensight is running, thus we use a specific URI host and not relative.
+            html = f"<script src='{self._http_protocol}://{self._session.html_hostname}:{self._session.html_port}/ansys/nexus/viewer-loader.js'></script>\n"
+            html += f"<ansys-nexus-viewer src='{self._http_protocol}://{self._session.html_hostname}:{self._session.html_port}/{self._avz_filename}"
+            html += f"{self._get_query_parameters_str()}'></ansys-nexus-viewer>\n"
+        else:
+            html = "<script src='/ansys/nexus/viewer-loader.js'></script>\n"
+            html += f"<ansys-nexus-viewer src='/{self._avz_filename}{self._get_query_parameters_str()}'></ansys-nexus-viewer>\n"
         # refresh the remote HTML
         self._save_remote_html_page(html)
         super().update()
@@ -483,6 +529,11 @@ class RenderableVNC(Renderable):
     def __init__(self, *args, **kwargs) -> None:
         super().__init__(*args, **kwargs)
+        self._query_params = {
+            "autoconnect": "true",
+            "host": self._session.html_hostname,
+            "port": self._session.ws_port,
+        }
         self._rendertype = "remote"
         self.update()
@@ -493,9 +544,9 @@ class RenderableVNC(Renderable):
         iframe reference.
         """
-        url = f"http://{self._session.hostname}:{self._session.html_port}"
+        url = f"{self._http_protocol}://{self._session.html_hostname}:{self._session.html_port}"
         url += "/ansys/nexus/novnc/vnc_envision.html"
-        url += f"?autoconnect=true&host={self._session.hostname}&port={self._session.ws_port}"
+        url += self._get_query_parameters_str(self._query_params)
         self._url = url
         super().update()
@@ -504,13 +555,19 @@ class RenderableVNC(Renderable):
 class RenderableVNCAngular(Renderable):
     def __init__(self, *args, **kwargs) -> None:
         super().__init__(*args, **kwargs)
+        self._query_params = {
+            "autoconnect": "true",
+            "host": self._session.hostname,
+            "port": self._session.ws_port,
+            "secretKey": self._session.secret_key,
+        }
         self._rendertype = "remote"
         self.update()
     def update(self):
-        url = f"http://{self._session.hostname}:{self._session.html_port}"
+        url = f"{self._http_protocol}://{self._session.html_hostname}:{self._session.html_port}"
         url += "/ansys/nexus/angular/viewer_angular_pyensight.html"
-        url += f"?autoconnect=true&host={self._session.hostname}&port={self._session.ws_port}&secretKey={self._session.secret_key}"
+        url += self._get_query_parameters_str(self._query_params)
         self._url = url
         super().update()
@@ -559,17 +616,33 @@ class RenderableEVSN(Renderable):
         self._session.ensight.file.save_scenario_fileslct(self._evsn_pathname)
         # generate HTML page with file references local to the websocketserver root
-        html = "<script src='/ansys/nexus/viewer-loader.js'></script>\n"
-        server = f"http://{self._session.hostname}:{self._session.html_port}"
-        cleanname = self._evsn_pathname.replace("\\", "/")
+        optional_query = self._get_query_parameters_str()
+        html = f"<script src='/ansys/nexus/viewer-loader.js{optional_query}'></script>\n"
+        server = f"{self._http_protocol}://{self._session.html_hostname}:{self._session.html_port}"
+        # FIXME: This method doesn't work with Ansys Lab since the viewer seems to require
+        # a full pathname to the file being generated by EnSight on a shared file system.
+        # The following commented out line should replace the two after that, but that
+        # prevents running locally from working since it's not using the full pathname to
+        # the shared file. -MFK
+        cleanname = self._evsn_filename.replace("\\", "/")
         attributes = f"src='{cleanname}'"
-        attributes += f" proxy_img='/{self._proxy_filename}'"
+        # attributes = f"src='{cleanname}{optional_query}'"
+        attributes += f" proxy_img='/{self._proxy_filename}{optional_query}'"
         attributes += " aspect_ratio='proxy'"
         attributes += " renderer='envnc'"
         http_uri = f'"http":"{server}"'
-        ws_uri = f'"ws":"http://{self._session.hostname}:{self._session.ws_port}"'
+        ws_uri = (
+            f'"ws":"{self._http_protocol}://{self._session.html_hostname}:{self._session.ws_port}"'
+        )
         secrets = f'"security_token":"{self._session.secret_key}"'
-        attributes += f"renderer_options='{{ {http_uri}, {ws_uri}, {secrets} }}'"
+        if not self._using_proxy or optional_query == "":
+            attributes += f" renderer_options='{{ {http_uri}, {ws_uri}, {secrets} }}'"
+        else:
+            query_args = f'"extra_query_args":"{optional_query[1:]}"'
+            attributes += f" renderer_options='{{ {http_uri}, {ws_uri}, {secrets}, {query_args} }}'"
         html += f"<ansys-nexus-viewer {attributes}></ansys-nexus-viewer>\n"
         # refresh the remote HTML
         self._save_remote_html_page(html)
@@ -622,12 +695,14 @@ class RenderableSGEO(Renderable):  # pragma: no cover
         # If the first update, generate the HTML
         if self._revision == 0:
             # generate HTML page with file references local to the websocketserver root
-            attributes = f"src='/{self._sgeo_base_filename}/geometry.sgeo'"
-            attributes += f" proxy_img='/{self._sgeo_base_filename}/proxy.png'"
+            attributes = (
+                f"src='/{self._sgeo_base_filename}/geometry.sgeo{self._get_query_parameters_str()}'"
+            )
+            attributes += f" proxy_img='/{self._sgeo_base_filename}/proxy.png{self._get_query_parameters_str()}'"
             attributes += " aspect_ratio='proxy'"
             attributes += " renderer='sgeo'"
-            html = "<script src='/ansys/nexus/viewer-loader.js'></script>\n"
+            html = f"<script src='/ansys/nexus/viewer-loader.js{self._get_query_parameters_str()}'></script>\n"
             html += f"<ansys-nexus-viewer id='{self._guid}' {attributes}></ansys-nexus-viewer>\n"
             html += self._periodic_script()
             # refresh the remote HTML
@@ -662,7 +737,7 @@ class RenderableSGEO(Renderable):  # pragma: no cover
         html_source = os.path.join(os.path.dirname(__file__), "sgeo_poll.html")
         with open(html_source, "r") as fp:
             html = fp.read()
-        revision_uri = f"/{self._sgeo_base_filename}/geometry.rev"
+        revision_uri = f"/{self._sgeo_base_filename}/geometry.rev{self._get_query_parameters_str()}"
         html = html.replace("REVURL_ITEMID", revision_uri)
         html = html.replace("ITEMID", self._guid)
         return html

ansys/pyensight/core/session.py CHANGED Viewed

@@ -77,6 +77,9 @@ class Session:
         The default is ``""``.
     grpc_port : int, optional
         Port number of the EnSight gRPC service. The default is ``12345``.
+    html_host : str, optional
+        Optional hostname for html connections if different than host
+        Used by Ansys Lab and reverse proxy servers
     html_port : int, optional
         Port number of the websocket server's HTTP server. The default is
         ``None``.
@@ -113,6 +116,7 @@ class Session:
         install_path: Optional[str] = None,
         secret_key: str = "",
         grpc_port: int = 12345,
+        html_hostname: Optional[str] = None,
         html_port: Optional[int] = None,
         ws_port: Optional[int] = None,
         session_directory: Optional[str] = None,
@@ -131,6 +135,11 @@ class Session:
         self._hostname = host
         self._install_path = install_path
         self._launcher = None
+        if html_hostname == "" or html_hostname is None:
+            # if we weren't given an html host, use the hostname
+            self._html_hostname = self._hostname
+        else:
+            self._html_hostname = html_hostname
         self._html_port = html_port
         self._ws_port = ws_port
         self._secret_key = secret_key
@@ -192,7 +201,8 @@ class Session:
             session_dir = self.launcher.session_directory
         s = f"Session(host='{self.hostname}', secret_key='{self.secret_key}', "
         s += f"sos={self.sos}, rest_api={self.rest_api}, "
-        s += f"html_port={self.html_port}, grpc_port={self._grpc_port}, "
+        s += f"html_hostname={self.html_hostname}, html_port={self.html_port}, "
+        s += f"grpc_port={self._grpc_port}, "
         s += f"ws_port={self.ws_port}, session_directory=r'{session_dir}')"
         return s
@@ -227,7 +237,14 @@ class Session:
         """
         if not self.rest_api:
             return
-        url = f"http://{self.hostname}:{self.html_port}/ensight/v1/session/exec"
+        #
+        #
+        # even when using PIM and a proxy server (Ansys Lab) this connects
+        # directly from the python running in the Notebook (the front-end)
+        # to the EnSight Docker Container and not the proxy server.
+        # Thus, here we use 'http', the private hostname, and the html port
+        # (which is the same on the proxy server).
+        url = f"http://{self._hostname}:{self.html_port}/ensight/v1/session/exec"
         time_start = time.time()
         while time.time() - time_start < self._timeout:
             try:
@@ -343,6 +360,11 @@ class Session:
         """Hostname of the system hosting the EnSight instance."""
         return self._hostname
+    @property
+    def html_hostname(self) -> str:
+        """Hostname of the system hosting the EnSight web server instance."""
+        return self._html_hostname
     @property
     def launcher(self) -> "Launcher":
         """Reference to the launcher instance if a launcher was used to instantiate the session."""

{ansys_pyensight_core-0.6.1.dist-info → ansys_pyensight_core-0.6.2.dist-info}/METADATA RENAMED Viewed

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: ansys-pyensight-core
-Version: 0.6.1
+Version: 0.6.2
 Summary: A python wrapper for Ansys EnSight
 Author-email: "ANSYS, Inc." <pyansys.core@ansys.com>
 Maintainer-email: "ANSYS, Inc." <pyansys.core@ansys.com>

{ansys_pyensight_core-0.6.1.dist-info → ansys_pyensight_core-0.6.2.dist-info}/RECORD RENAMED Viewed

@@ -1,17 +1,17 @@
 ansys/pyensight/core/__init__.py,sha256=ZOASvqNxSR8CGJDHQACGwjtFVvI_vmmfbpy1IAmEJhk,828
-ansys/pyensight/core/deep_pixel_view.html,sha256=86JNwI-Q5iXtBEbkVUDLSK0D7PxJB3O5enlRsslMZBY,3351
-ansys/pyensight/core/dockerlauncher.py,sha256=DYC1RsJmof_dIj0VrIlZ7IiRhQ0yLg57IsKcJBTCtTU,25129
+ansys/pyensight/core/deep_pixel_view.html,sha256=oZmcCIS3Dqqsoj8oheYubLAH2ZVKXao3iJM2WXYBEKs,3421
+ansys/pyensight/core/dockerlauncher.py,sha256=Bf3NsjxRhF4-rvgBv56v82EYaMYVr6k0hCYA8qwVvrc,27191
 ansys/pyensight/core/enscontext.py,sha256=UfeFvY4ZyOcIkgKcIyhs3GohZhWl515QFhJtBxvIfpE,11803
-ansys/pyensight/core/enshell_grpc.py,sha256=veRCXgP_7CMOdPS4gU_tOT6KkA9c56NXxkZEHRFWTTc,14963
+ansys/pyensight/core/enshell_grpc.py,sha256=nNvJqrFG_-glM90dPAC6anFT9qXg7WohQ6CoULXgaSQ,15134
 ansys/pyensight/core/ensight_grpc.py,sha256=yFnvxjI2cAWd0c0gcM46MEIA5Ov7DUMlufqUwwc3g9U,14343
 ansys/pyensight/core/ensobj.py,sha256=tynUyYrpzCz2lvcse6fcmutnG6Jj111s518OlO19EqE,17354
-ansys/pyensight/core/launch_ensight.py,sha256=p8eT7_Z7W_pPUxRZKrUbK6qJbhqVZkzobJt5E19Az8o,5940
-ansys/pyensight/core/launcher.py,sha256=3MzPugpBh2WPkq24yX_1vypzKiTR8Dx5E5rS1i5FO2Q,8977
+ansys/pyensight/core/launch_ensight.py,sha256=KqUq3dYc2j4aKMkZYu9rXXw7ODZDqFbD6kx4Vt0uJcg,5915
+ansys/pyensight/core/launcher.py,sha256=zj-6DBp307-IJ0RTDmZOxCFVGemJu8YaagJLZFLloNw,10445
 ansys/pyensight/core/listobj.py,sha256=vsVTeI3RY0P1n5GNOHW-iU95GCWnHlOg_E6leVMQScw,8223
 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=-eVJd1X_8saziCO9EWP7zVz3N62WFPWp8Yy95zdJCxc,26860
-ansys/pyensight/core/session.py,sha256=Eoss0yZFV_YVlEflSb6sjxU5XzgvknrdsR0iTKr5ZRM,60023
+ansys/pyensight/core/renderable.py,sha256=z61Pum_Pa2CVoXVWOCqPngeHT_ifBS3fpqA5mZDDmnc,30777
+ansys/pyensight/core/session.py,sha256=fI-Z_dNJz7wD_wOabF7-jd1lSq8z3KsqS70ECeAz4NY,61036
 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
@@ -20,7 +20,7 @@ ansys/pyensight/core/utils/parts.py,sha256=x0Zso-ef64UJ-3BmYS3dymjftaWQI21WFTsDt
 ansys/pyensight/core/utils/query.py,sha256=cQXt_07ZuNAwueAIXinI3_f7G9lXass6j7G0aRJltZE,19035
 ansys/pyensight/core/utils/support.py,sha256=gNBH_VyQ_Gdas7P28W_GZ62Tz4Gg7YK8UASUzdT-lSU,2397
 ansys/pyensight/core/utils/views.py,sha256=vf4gSBRl6uC_LPwZdzrdMcR0dyi_PwYmRo20CPmjEBE,12209
-ansys_pyensight_core-0.6.1.dist-info/LICENSE,sha256=qQWivZ12ETN5l3QxvTARY-QI5eoRRlyHdwLlAj0Bg5I,1089
-ansys_pyensight_core-0.6.1.dist-info/WHEEL,sha256=EZbGkh7Ie4PoZfRQ8I0ZuP9VklN_TvcZ6DSE5Uar4z4,81
-ansys_pyensight_core-0.6.1.dist-info/METADATA,sha256=R1G_6oQ-lZNIiqIEO_OQHCJ-PVJwqxhvVm-LA6GagjM,11804
-ansys_pyensight_core-0.6.1.dist-info/RECORD,,
+ansys_pyensight_core-0.6.2.dist-info/LICENSE,sha256=qQWivZ12ETN5l3QxvTARY-QI5eoRRlyHdwLlAj0Bg5I,1089
+ansys_pyensight_core-0.6.2.dist-info/WHEEL,sha256=EZbGkh7Ie4PoZfRQ8I0ZuP9VklN_TvcZ6DSE5Uar4z4,81
+ansys_pyensight_core-0.6.2.dist-info/METADATA,sha256=xrpWIqcf30R_4dS1BEvbpSxWvDMTqkUxa5uf3I9wMxI,11804
+ansys_pyensight_core-0.6.2.dist-info/RECORD,,

{ansys_pyensight_core-0.6.1.dist-info → ansys_pyensight_core-0.6.2.dist-info}/LICENSE RENAMED Viewed

File without changes

{ansys_pyensight_core-0.6.1.dist-info → ansys_pyensight_core-0.6.2.dist-info}/WHEEL RENAMED Viewed

File without changes

ansys-pyensight-core 0.6.1__py3-none-any.whl → 0.6.2__py3-none-any.whl

Potentially problematic release.

ansys-pyensight-core 0.6.1py3-none-any.whl → 0.6.2py3-none-any.whl