ansys-fluent-visualization 0.18.0__tar.gz → 0.19.dev0__tar.gz

{ansys_fluent_visualization-0.18.0 → ansys_fluent_visualization-0.19.dev0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: ansys-fluent-visualization
-Version: 0.18.0
+Version: 0.19.dev0
 Summary: A python wrapper for ansys Fluent visualization
 License: MIT
 Author: ANSYS, Inc.
@@ -16,11 +16,15 @@ Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
-Requires-Dist: ansys-fluent-core (==0.29.0)
+Requires-Dist: ansys-fluent-core (>=0.30.dev2,<1.0)
+Requires-Dist: imageio (>=2.36.1)
+Requires-Dist: importlib-metadata (>=4.0,<5.0) ; python_version < "3.9"
 Requires-Dist: matplotlib (>=3.6.0)
+Requires-Dist: plotly (>=5.24.0)
 Requires-Dist: pyside6 (>=6.8.1,<6.9.0)
-Requires-Dist: pyvista (>=0.44.0)
+Requires-Dist: pyvista[jupyter] (>=0.44.0)
 Requires-Dist: pyvistaqt (>=0.11.1,<0.12.0)
+Requires-Dist: vtk (<9.4.0) ; python_version < "3.13"
 Project-URL: Documentation, https://visualization.fluent.docs.pyansys.com/
 Project-URL: Repository, https://github.com/ansys/pyfluent-visualization
 Project-URL: Source, https://github.com/ansys/pyfluent-visualization

{ansys_fluent_visualization-0.18.0 → ansys_fluent_visualization-0.19.dev0}/pyproject.toml

@@ -5,7 +5,7 @@ build-backend = "poetry.core.masonry.api"
 [tool.poetry]
 # Check https://python-poetry.org/docs/pyproject/ for all available sections
 name = "ansys-fluent-visualization"
-version = "0.18.0"
+version = "0.19.dev0"
 description = "A python wrapper for ansys Fluent visualization"
 license = "MIT"
 authors = ["ANSYS, Inc. <ansys.support@ansys.com>"]
@@ -24,11 +24,15 @@ packages = [
 
 [tool.poetry.dependencies]
 python = ">=3.10,<4.0"
-ansys-fluent-core = "==0.29.0"
-pyvista = ">=0.44.0"
+importlib-metadata = {version = "^4.0", python = "<3.9"}
+ansys-fluent-core = "~=0.30.dev2"
+pyvista = { version = ">=0.44.0", extras = ["jupyter"]}
 matplotlib = ">=3.6.0"
+vtk = {version = "<9.4.0", python = "<3.13"}
 pyvistaqt = "~=0.11.1"
 pyside6 = "~=6.8.1"
+plotly = ">=5.24.0"
+imageio= ">=2.36.1"
 
 [tool.poetry.urls]
 "Documentation" = "https://visualization.fluent.docs.pyansys.com/"

{ansys_fluent_visualization-0.18.0 → ansys_fluent_visualization-0.19.dev0}/src/ansys/fluent/visualization/__init__.py

@@ -27,7 +27,7 @@ try:
 except ModuleNotFoundError:
     import importlib_metadata
 
-_VERSION_INFO = "Build date: February 20, 2025 13:32 UTC ShaID: d8bef97"
+_VERSION_INFO = "Build date: March 11, 2025 08:48 UTC ShaID: 45ba314"
 __version__ = importlib_metadata.version(__name__.replace(".", "-"))
 PLOTTER = "matplotlib"
 SINGLE_WINDOW = False

{ansys_fluent_visualization-0.18.0 → ansys_fluent_visualization-0.19.dev0}/src/ansys/fluent/visualization/graphics/graphics_windows.py

@@ -113,22 +113,47 @@ class GraphicsWindow:
 
     def save_graphic(
         self,
-        format: str,
+        filename: str,
     ) -> None:
-        """Save a graphics.
+        """Save a screenshot of the rendering window as a graphic file.
 
         Parameters
         ----------
-        format : str
-            Graphic file format. Supported formats are SVG, EPS, PS, PDF, and TEX.
+        filename : str
+            Path to save the graphic file to.
+            Supported formats are SVG, EPS, PS, PDF, and TEX.
 
         Raises
         ------
         ValueError
             If the window does not support the specified format.
+
+        Examples
+        --------
+        >>> import ansys.fluent.core as pyfluent
+        >>> from ansys.fluent.core import examples
+        >>> from ansys.fluent.visualization import GraphicsWindow, Vector
+        >>>
+        >>> import_case = examples.download_file(
+        >>> file_name="exhaust_system.cas.h5", directory="pyfluent/exhaust_system"
+        >>> )
+        >>> import_data = examples.download_file(
+        >>> file_name="exhaust_system.dat.h5", directory="pyfluent/exhaust_system"
+        >>> )
+        >>>
+        >>> solver_session = pyfluent.launch_fluent()
+        >>> solver_session.settings.file.read_case(file_name=import_case)
+        >>> solver_session.settings.file.read_data(file_name=import_data)
+        >>>
+        >>> velocity_vector = Vector(
+        >>> solver=solver_session, field="pressure", surfaces=["solid_up:1:830"]
+        >>> )
+        >>> graphics_window = GraphicsWindow()
+        >>> graphics_window.add_graphics(velocity_vector)
+        >>> graphics_window.save_graphic("saved_vector.svg")
         """
         if self.window_id:
-            self._renderer.save_graphic(f"{self.window_id}.{format}")
+            self._renderer.save_graphic(filename)
 
     def refresh_windows(
         self,