ansys-pyensight-core 0.6.2__tar.gz → 0.7.0__tar.gz

{ansys_pyensight_core-0.6.2 → ansys_pyensight_core-0.7.0}/PKG-INFO

@@ -1,24 +1,24 @@
 Metadata-Version: 2.1
 Name: ansys-pyensight-core
-Version: 0.6.2
+Version: 0.7.0
 Summary: A python wrapper for Ansys EnSight
 Author-email: "ANSYS, Inc." <pyansys.core@ansys.com>
 Maintainer-email: "ANSYS, Inc." <pyansys.core@ansys.com>
-Requires-Python: >=3.8,<4
+Requires-Python: >=3.9,<4
 Description-Content-Type: text/x-rst
 Classifier: Development Status :: 4 - Beta
 Classifier: Intended Audience :: Science/Research
 Classifier: Topic :: Scientific/Engineering :: Information Analysis
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Operating System :: OS Independent
-Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
 Requires-Dist: importlib-metadata>=4.0; python_version<='3.8'
 Requires-Dist: ansys-api-pyensight==0.3.2
 Requires-Dist: requests>=2.28.2
-Requires-Dist: pyansys-docker>=5.0.4
+Requires-Dist: docker>=6.1.0
 Requires-Dist: urllib3<2
 Requires-Dist: typing>=3.7.4.3
 Requires-Dist: typing-extensions>=4.5.0
@@ -35,7 +35,7 @@ Requires-Dist: ansys-sphinx-theme==0.9.9 ; extra == "doc"
 Requires-Dist: sphinx-copybutton==0.5.2 ; extra == "doc"
 Requires-Dist: sphinx-gallery==0.13.0 ; extra == "doc"
 Requires-Dist: sphinxcontrib-mermaid==0.9.2 ; extra == "doc"
-Requires-Dist: pyansys-docker>=5.0.4 ; extra == "doc"
+Requires-Dist: docker>=6.1.0 ; extra == "doc"
 Requires-Dist: matplotlib==3.7.2 ; extra == "doc"
 Requires-Dist: requests>=2.28.2 ; extra == "doc"
 Requires-Dist: sphinxcontrib.jquery==4.1 ; extra == "doc"
@@ -47,7 +47,7 @@ Requires-Dist: dill>=0.3.5.1 ; extra == "tests"
 Requires-Dist: pytest-mock==3.10.0 ; extra == "tests"
 Requires-Dist: urllib3==1.26.10 ; extra == "tests"
 Requires-Dist: requests>=2.28.2 ; extra == "tests"
-Requires-Dist: pyansys-docker>=5.0.4 ; extra == "tests"
+Requires-Dist: docker>=6.1.0 ; extra == "tests"
 Project-URL: Changelog, https://github.com/ansys/pyensight/blob/main/CHANGELOG.rst
 Project-URL: Documentation, https://ensight.docs.pyansys.com/
 Project-URL: Homepage, https://github.com/ansys/pyensight
@@ -131,7 +131,7 @@ Installation
 ------------
 To use PyEnSight, you must have a locally installed and licensed copy of
 Ansys EnSight 2022 R2 or later. The ``ansys-pyensight-core`` package supports
-Python 3.8 through Python 3.11 on Windows and Linux.
+Python 3.9 through Python 3.12 on Windows and Linux.
 
 Two modes of installation are available:
 

{ansys_pyensight_core-0.6.2 → ansys_pyensight_core-0.7.0}/README.rst

@@ -72,7 +72,7 @@ Installation
 ------------
 To use PyEnSight, you must have a locally installed and licensed copy of
 Ansys EnSight 2022 R2 or later. The ``ansys-pyensight-core`` package supports
-Python 3.8 through Python 3.11 on Windows and Linux.
+Python 3.9 through Python 3.12 on Windows and Linux.
 
 Two modes of installation are available:
 

{ansys_pyensight_core-0.6.2 → ansys_pyensight_core-0.7.0}/pyproject.toml

@@ -6,10 +6,10 @@ build-backend = "flit_core.buildapi"
 
 [project]
 name = "ansys-pyensight-core"
-version = "0.6.2"
+version = "0.7.0"
 description = "A python wrapper for Ansys EnSight"
 readme = "README.rst"
-requires-python = ">=3.8,<4"
+requires-python = ">=3.9,<4"
 license = {file = "LICENSE"}
 authors = [{name = "ANSYS, Inc.", email = "pyansys.core@ansys.com"}]
 maintainers = [{name = "ANSYS, Inc.", email = "pyansys.core@ansys.com"}]
@@ -19,17 +19,17 @@ classifiers = [
     "Topic :: Scientific/Engineering :: Information Analysis",
     "License :: OSI Approved :: MIT License",
     "Operating System :: OS Independent",
-    "Programming Language :: Python :: 3.8",
     "Programming Language :: Python :: 3.9",
     "Programming Language :: Python :: 3.10",
     "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
 ]
 
 dependencies = [
     "importlib-metadata>=4.0; python_version<='3.8'",
     "ansys-api-pyensight==0.3.2",
     "requests>=2.28.2",
-    "pyansys-docker>=5.0.4",
+    "docker>=6.1.0",
     "urllib3<2",
     "typing>=3.7.4.3",
     "typing-extensions>=4.5.0",
@@ -52,7 +52,7 @@ tests = [
     "pytest-mock==3.10.0",
     "urllib3==1.26.10",
     "requests>=2.28.2",
-    "pyansys-docker>=5.0.4",
+    "docker>=6.1.0",
 ]
 doc = [
     "Sphinx==7.0.1",
@@ -61,7 +61,7 @@ doc = [
     "sphinx-copybutton==0.5.2",
     "sphinx-gallery==0.13.0",
     "sphinxcontrib-mermaid==0.9.2",
-    "pyansys-docker>=5.0.4",
+    "docker>=6.1.0",
     "matplotlib==3.7.2",
     "requests>=2.28.2",
     "sphinxcontrib.jquery==4.1",
@@ -113,7 +113,7 @@ minversion = "7.1"
 testpaths = [
     "tests",
 ]
-addopts = "--setup-show --cov=ansys.pyensight.core --cov=ansys.api.pyensight --cov-report html:coverage-html --cov-report term --cov-config=.coveragerc --capture=tee-sys --tb=native -p no:warnings"
+addopts = "--setup-show --cov=ansys.pyensight.core --cov-report html:coverage-html --cov-report term --cov-config=.coveragerc --capture=tee-sys --tb=native -p no:warnings"
 markers =[
     "integration:Run integration tests",
     "smoke:Run the smoke tests",
@@ -144,7 +144,7 @@ recursive = true
 exclude = ["venv/*", "tests/*"]
 
 [tool.mypy]
-python_version = 3.8
+python_version = 3.9
 strict = false
 namespace_packages = true
 explicit_package_bases = true

{ansys_pyensight_core-0.6.2 → ansys_pyensight_core-0.7.0}/src/ansys/pyensight/core/dockerlauncher.py

@@ -193,7 +193,7 @@ class DockerLauncher(Launcher):
 
             self._docker_client = docker.from_env()
         except ModuleNotFoundError:
-            raise RuntimeError("The pyansys-docker module must be installed for DockerLauncher")
+            raise RuntimeError("The docker module must be installed for DockerLauncher")
         except Exception:
             raise RuntimeError("Cannot initialize Docker")
 
@@ -308,7 +308,7 @@ class DockerLauncher(Launcher):
         try:
             import docker
         except ModuleNotFoundError:  # pragma: no cover
-            raise RuntimeError("The pyansys-docker module must be installed for DockerLauncher")
+            raise RuntimeError("The docker module must be installed for DockerLauncher")
         except Exception:  # pragma: no cover
             raise RuntimeError("Cannot initialize Docker")
 

{ansys_pyensight_core-0.6.2 → ansys_pyensight_core-0.7.0}/src/ansys/pyensight/core/session.py

@@ -1113,6 +1113,55 @@ class Session:
             if self.cmd(cmd) != 0:
                 raise RuntimeError("Unable to load the dataset.")
 
+    def download_pyansys_example(
+        self, filename: str, directory: Optional[str] = None, root: Optional[str] = None
+    ) -> str:
+        """Download an example dataset from the ansys/example-data repository.
+        The dataset is downloaded local to the EnSight server location, so that it can
+        be downloaded even if running from a container.
+
+        Parameters
+        ----------
+        filename: str
+            The filename to download
+        directory: str
+            The directory to download the filename from
+        root: str
+            If set, the download will happen from another location
+
+        Returns
+        -------
+        pathname: str
+            The download location, local to the EnSight server directory
+
+        Examples
+        --------
+        >>> from ansys.pyensight.core import DockerLauncher
+        >>> session = DockerLauncher().start(data_directory="D:\\")
+        >>> cas_file = session.download_pyansys_example("mixing_elbow.cas.h5","pyfluent/mixing_elbow")
+        >>> dat_file = session.download_pyansys_example("mixing_elbow.dat.h5","pyfluent/mixing_elbow")
+        >>> session.load_data(cas_file, result_file=dat_file)
+        >>> remote = session.show("remote")
+        >>> remote.browser()
+        """
+        base_uri = "https://github.com/ansys/example-data/raw/master"
+        if root is not None:
+            base_uri = root
+        uri = f"{base_uri}/{filename}"
+        if directory:
+            uri = f"{base_uri}/{directory}/{filename}"
+        pathname = f"{self.launcher.session_directory}/{filename}"
+        script = "import requests\n"
+        script += "import shutil\n"
+        script += "import os\n"
+        script += f'url = "{uri}"\n'
+        script += f'outpath = r"""{pathname}"""\n'
+        script += "with requests.get(url, stream=True) as r:\n"
+        script += "    with open(outpath, 'wb') as f:\n"
+        script += "        shutil.copyfileobj(r.raw, f)\n"
+        self.cmd(script, do_eval=False)
+        return pathname
+
     def load_example(
         self, example_name: str, uncompress: bool = False, root: Optional[str] = None
     ) -> str:
@@ -1151,16 +1200,8 @@ class Session:
         base_uri = "https://s3.amazonaws.com/www3.ensight.com/PyEnSight/ExampleData"
         if root is not None:
             base_uri = root
-        uri = f"{base_uri}/{example_name}"
-        pathname = f"{self.launcher.session_directory}/{example_name}"
-        script = "import requests\n"
-        script += "import shutil\n"
-        script += "import os\n"
-        script += f'url = "{uri}"\n'
-        script += f'outpath = r"""{pathname}"""\n'
-        script += "with requests.get(url, stream=True) as r:\n"
-        script += "    with open(outpath, 'wb') as f:\n"
-        script += "        shutil.copyfileobj(r.raw, f)\n"
+        pathname = self.download_pyansys_example(example_name, root=base_uri)
+        script = f'outpath = r"""{pathname}"""\n'
         if uncompress:
             # in this case, remove the extension and unzip the file
             pathname_dir = os.path.splitext(pathname)[0]

{ansys_pyensight_core-0.6.2 → ansys_pyensight_core-0.7.0}/src/ansys/pyensight/core/utils/export.py

@@ -73,8 +73,6 @@ class Export:
     ) -> None:
         """Render an image of the current EnSight scene.
 
-        This method returns a PIL image object.
-
         Parameters
         ----------
         filename : str
@@ -464,3 +462,108 @@ class Export:
                 mp4_data = fp.read()
 
         return mp4_data
+
+    GEOM_EXPORT_GLTF = "gltf2"
+    GEOM_EXPORT_AVZ = "avz"
+    GEOM_EXPORT_PLY = "ply"
+    GEOM_EXPORT_STL = "stl"
+
+    extension_map = {
+        GEOM_EXPORT_GLTF: ".glb",
+        GEOM_EXPORT_AVZ: ".avz",
+        GEOM_EXPORT_PLY: ".ply",
+        GEOM_EXPORT_STL: ".stl",
+    }
+
+    def _geometry_remote(
+        self, format: str, starting_timestep: int, frames: int, delta_timestep: int
+    ) -> bytes:
+        """EnSight-side implementation.
+
+        Parameters
+        ----------
+        format : str
+            The format to export
+        starting_timestep: int
+            The first timestep to export. If None, defaults to the current timestep
+        frames: int
+            Number of timesteps to save. If None, defaults from the current timestep to the last
+        delta_timestep: int
+            The delta timestep to use when exporting
+
+        Returns
+        -------
+        bytes
+            Geometry export in bytes
+        """
+        rawdata = None
+        extension = self.extension_map.get(format)
+        if not extension:
+            raise RuntimeError("The geometry export format provided is not supported.")
+        with tempfile.TemporaryDirectory() as tmpdirname:
+            self._ensight.part.select_all()
+            self._ensight.savegeom.format(format)
+            self._ensight.savegeom.begin_step(starting_timestep)
+            # frames is 1-indexed, so I need to decrease of 1
+            self._ensight.savegeom.end_step(starting_timestep + frames - 1)
+            self._ensight.savegeom.step_by(delta_timestep)
+            tmpfilename = os.path.join(tmpdirname, str(uuid.uuid1()))
+            self._ensight.savegeom.save_geometric_entities(tmpfilename)
+            with open(tmpfilename + extension, "rb") as tmpfile:
+                rawdata = tmpfile.read()
+        return rawdata
+
+    def geometry(
+        self,
+        filename: str,
+        format: str = GEOM_EXPORT_GLTF,
+        starting_timestep: Optional[int] = None,
+        frames: Optional[int] = 1,
+        delta_timestep: Optional[int] = None,
+    ) -> None:
+        """Export a geometry file.
+
+        Parameters
+        ----------
+        filename: str
+            The location where to export the geometry
+        format : str
+            The format to export
+        starting_timestep: int
+            The first timestep to export. If None, defaults to the current timestep
+        frames: int
+            Number of timesteps to save. If None, defaults from the current timestep to the last
+        delta_timestep: int
+            The delta timestep to use when exporting
+
+        Examples
+        --------
+        >>> s = LocalLauncher().start()
+        >>> data = f"{s.cei_home}/ensight{s.cei_suffix}gui/demos/Crash Queries.ens"
+        >>> s.ensight.objs.ensxml_restore_file(data)
+        >>> s.ensight.utils.export.geometry("local_file.glb", format=s.ensight.utils.export.GEOM_EXPORT_GLTF)
+        """
+        if not starting_timestep:
+            starting_timestep = int(self._ensight.objs.core.TIMESTEP)
+        if not frames or frames == -1:
+            # Timesteps are 0-indexed so frames need to be increased of 1
+            frames = int(self._ensight.objs.core.TIMESTEP_LIMITS[1]) + 1
+        if not delta_timestep:
+            delta_timestep = 1
+        self._remote_support_check()
+        raw_data = None
+        if isinstance(self._ensight, ModuleType):
+            raw_data = self._geometry_remote(
+                format,
+                starting_timestep=starting_timestep,
+                frames=frames,
+                delta_timestep=delta_timestep,
+            )
+        else:
+            cmd = f"ensight.utils.export._geometry_remote('{format}', {starting_timestep}, {frames}, {delta_timestep})"
+            raw_data = self._ensight._session.cmd(cmd)
+        if raw_data:
+            with open(filename, "wb") as fp:
+                fp.write(raw_data)
+        else:
+            raise IOError("Export was not successful")

{ansys_pyensight_core-0.6.2 → ansys_pyensight_core-0.7.0}/src/ansys/pyensight/core/utils/support.py

@@ -31,24 +31,46 @@ class Support:
     def __init__(self, interface: Union["ensight_api.ensight", "ensight"]):
         self._ensight = interface
 
-    @staticmethod
-    def scoped_name(obj: Any) -> ContextManager:
+    def scoped_name(self, obj: Any, native_exceptions: bool = False) -> ContextManager:
         """Allow for the use of ``with`` to shorten APIs.
 
         In the EnSight and PyEnsight APIs, the interfaces can become lengthy.
         This class makes it possible to shorten APIs for modules, classes,
-        and namespaces.
+        and namespaces.  The native_exceptions keyword can be used to enable
+        exceptions for EnSight native Python API.  By default, an invalid
+        native API call like ``ensight.part.select_begin(-9999)`` will return
+        -1.  If native_exceptions is True, a Python exception will be thrown.
+        The scope of this operational change parallels the scoped_name()
+        instance.
+
+        Parameters
+        ----------
+        obj: Any
+            The object for which to generate a simplified namespace.
+        native_exceptions: bool
+            If True, then EnSight native Python API exceptions are enabled.
+            The default is False.
+
+        Returns
+        -------
+        The passed object wrapped in a context manager that can be used as a
+        simplified namespace.
 
         Examples
         --------
         >>> sn = s.ensight.utils.support.scoped_name
         >>> with sn(s.ensight.objs.core) as core, sn(s.ensight.objs.enums) as enums:
         >>>     print(core.PARTS.find(True, enums.VISIBLE))
+
         >>> sn = ensight.utils.support.scoped_name
         >>> with sn(ensight.objs.core) as core, sn(ensight.objs.enums) as enums:
         >>>     print(core.PARTS.find(True, enums.VISIBLE))
+
+        >>> sn = ensight.utils.support.scoped_name
+        >>> with sn(ensight.part, native_exceptions=True) as part:
+        >>>     part.select_begin(-9999)
         """
-        return ScopedName(obj)
+        return ScopedName(self._ensight, obj, native_exceptions=native_exceptions)
 
 
 class ScopedName:
@@ -59,11 +81,26 @@ class ScopedName:
     and namespaces.
     """
 
-    def __init__(self, obj: Any):
+    def __init__(
+        self,
+        interface: Union["ensight_api.ensight", "ensight"],
+        obj: Any,
+        native_exceptions: bool = False,
+    ):
         self._obj = obj
+        self._ensight = interface
+        self._old_raise = None
+        if native_exceptions:
+            # if we are being asked to enable exceptions, record what to restore it to
+            self._old_raise = self._ensight.query("SENDMESG_RAISE")
 
     def __enter__(self) -> Any:
+        if self._old_raise is not None:
+            # if a restore value is set, enable them
+            self._ensight.sendmesgoptions(exception=1)
         return self._obj
 
     def __exit__(self, exc_type, exc_value, exc_trace):
-        pass
+        if self._old_raise is not None:
+            # if the restore value is set, restore it here
+            self._ensight.sendmesgoptions(exception=self._old_raise)