Merge branch 'main' of https://github.com/pyansys/pyfluent-visualization into main

Author: prmukherj

.github/workflows/ci_cd.yml

@@ -42,7 +42,7 @@ jobs:
     strategy:
       matrix:
         os: [windows-latest, ubuntu-latest]
-        python-version: ['3.10', '3.11', '3.12']
+        python-version: ['3.10', '3.11', '3.12', '3.13']
       fail-fast: false
 
     steps:

.github/workflows/nightly-test-run.yml

@@ -12,7 +12,7 @@ jobs:
     strategy:
       matrix:
         os: [windows-latest, ubuntu-latest]
-        python-version: ['3.10', '3.11', '3.12']
+        python-version: ['3.10', '3.11', '3.12', '3.13']
       fail-fast: false
 
     steps:

README.rst

@@ -51,7 +51,7 @@ the project support team, email `[email protected] <[email protected]>
 Installation
 ------------
 The ``ansys-fluent-visualization`` package supports Python 3.10 through Python
-3.12 on Windows and Linux.
+3.13 on Windows and Linux.
 
 If you are using Python 3.10, download and install the wheel file for the ``vtk`` package from
 `here for Windows <https://github.com/pyvista/pyvista-wheels/raw/main/vtk-9.1.0.dev0-cp310-cp310-win_amd64.whl>`_

doc/source/getting_started/index.rst

@@ -14,7 +14,7 @@ page on the Ansys website.
 Install package
 ***************
 The ``ansys-fluent-visualization`` package supports Python 3.10 through
-Python 3.12 on Windows and Linux.
+Python 3.13 on Windows and Linux.
 
 Install the latest release from `PyPi
 <https://pypi.org/project/ansys-fluent-visualization/>`_ with:

examples/00-postprocessing/updated_exhaust_manifold_example.py

@@ -40,7 +40,6 @@
     Mesh,
     Monitor,
     Pathline,
-    PlotterWindow,
     Surface,
     Vector,
     XYPlot,
@@ -252,8 +251,8 @@
     surfaces=["outlet"],
     y_axis_function="temperature",
 )
-p7 = PlotterWindow(grid=(2, 2))
-p7.add_plots(xy_plot, position=(0, 0))
+p7 = GraphicsWindow(grid=(2, 2))
+p7.add_graphics(xy_plot, position=(0, 0))
 
 ###############################################################################
 # Create residual plot
@@ -262,7 +261,7 @@
 
 residual = Monitor(solver=solver_session)
 residual.monitor_set_name = "residual"
-p7.add_plots(residual, position=(0, 1))
+p7.add_graphics(residual, position=(0, 1))
 
 ###############################################################################
 # Solve and plot solution monitors
@@ -274,10 +273,10 @@
 
 mass_bal_rplot = Monitor(solver=solver_session)
 mass_bal_rplot.monitor_set_name = "mass-bal-rplot"
-p7.add_plots(mass_bal_rplot, position=(1, 0))
+p7.add_graphics(mass_bal_rplot, position=(1, 0))
 
 point_vel_rplot = Monitor(solver=solver_session, monitor_set_name="point-vel-rplot")
-p7.add_plots(point_vel_rplot, position=(1, 1))
+p7.add_graphics(point_vel_rplot, position=(1, 1))
 p7.show()
 
 ###############################################################################

examples/00-postprocessing/updated_script_manifold_example.py

@@ -43,7 +43,6 @@
     Mesh,
     Monitor,
     Pathline,
-    PlotterWindow,
     Surface,
     Vector,
     XYPlot,
@@ -78,27 +77,27 @@
 
 p1 = XYPlot(solver=session, surfaces=["solid_up:1:830"])
 p1.y_axis_function = "temperature"
-p_xy = PlotterWindow()
-p_xy.add_plots(p1)
+p_xy = GraphicsWindow()
+p_xy.add_graphics(p1)
 p_xy.show()
 
 session.monitors.get_monitor_set_names()
 residual = Monitor(solver=session)
 residual.monitor_set_name = "residual"
-p_res = PlotterWindow()
-p_res.add_plots(residual)
+p_res = GraphicsWindow()
+p_res.add_graphics(residual)
 p_res.show()
 
 mtr = Monitor(solver=session)
 mtr.monitor_set_name = "mass-tot-rplot"
-p_mtr = PlotterWindow()
-p_mtr.add_plots(mtr)
+p_mtr = GraphicsWindow()
+p_mtr.add_graphics(mtr)
 p_mtr.show()
 
 mbr = Monitor(solver=session)
 mbr.monitor_set_name = "mass-bal-rplot"
-p_mbr = PlotterWindow()
-p_mbr.add_plots(mbr)
+p_mbr = GraphicsWindow()
+p_mbr.add_graphics(mbr)
 p_mbr.show()
 
 p_mesh = GraphicsWindow()
@@ -121,21 +120,20 @@
 p_surf.show()
 
 
-def auto_refersh_call_back_iteration(session_id, event_info):
-    if event_info.index % 1 == 0:
-        p_cont.refresh_windows(session_id)
-        p_res.refresh_windows(session_id)
-        p_mtr.refresh_windows(session_id)
-        p_mbr.refresh_windows(session_id)
+def auto_refersh_call_back_iteration(session, event_info):
+    p_cont.refresh_windows(session.id)
+    p_res.refresh_windows(session.id)
+    p_mtr.refresh_windows(session.id)
+    p_mbr.refresh_windows(session.id)
 
 
-def auto_refersh_call_back_time_step(session_id, event_info):
-    p_res.refresh_windows(session_id)
+def auto_refersh_call_back_time_step(session, event_info):
+    p_res.refresh_windows(session.id)
 
 
-def initialize_call_back(session_id, event_info):
-    p_res.refresh_windows(session_id)
-    p_mtr.refresh_windows(session_id)
+def initialize_call_back(session, event_info):
+    p_res.refresh_windows(session.id)
+    p_mtr.refresh_windows(session.id)
 
 
 cb_init_id = session.events.register_callback("InitializedEvent", initialize_call_back)

pyproject.toml

@@ -25,11 +25,14 @@ packages = [
 [tool.poetry.dependencies]
 python = ">=3.10,<4.0"
 importlib-metadata = {version = "^4.0", python = "<3.9"}
-ansys-fluent-core = "~=0.28.dev0"
-pyvista = "~=0.44.1"
+ansys-fluent-core = "~=0.29.dev0"
+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.7.2"
-matplotlib = ">=3.9.0"
+pyside6 = "~=6.8.1"
+plotly = ">=5.24.0"
+imageio= ">=2.36.1"
 
 [tool.poetry.urls]
 "Documentation" = "https://visualization.fluent.docs.pyansys.com/"

src/ansys/fluent/visualization/__init__.py

@@ -8,6 +8,7 @@
 _VERSION_INFO = None
 __version__ = importlib_metadata.version(__name__.replace(".", "-"))
 PLOTTER = "matplotlib"
+INTERACTIVE = False
 
 
 def version_info() -> str:

src/ansys/fluent/visualization/_config.py

@@ -11,10 +11,13 @@ def get_config() -> dict:
     config : dict
         Keys are parameter names that can be passed to :func:`set_config`.
     """
+    import ansys.fluent.visualization as pyviz
+
+    _global_config["blocking"] = not pyviz.INTERACTIVE
     return _global_config.copy()
 
 
-def set_config(blocking: bool = True, set_view_on_display: str = "isometric"):
+def set_config(blocking: bool = False, set_view_on_display: str = "isometric"):
     """Set visualization configuration.
 
     Parameters

src/ansys/fluent/visualization/graphics/graphics_windows.py

@@ -1,6 +1,8 @@
 """A wrapper to improve the user interface of graphics."""
 
+from ansys.fluent.visualization import get_config
 from ansys.fluent.visualization.graphics import graphics_windows_manager
+from ansys.fluent.visualization.plotter.plotter_windows import PlotterWindow
 
 
 class GraphicsWindow:
@@ -14,6 +16,7 @@ def add_graphics(
         object,
         position: tuple = (0, 0),
         opacity: float = 1,
+        title: str = "",
     ) -> None:
         """Add data to a plot.
 
@@ -25,27 +28,43 @@ def add_graphics(
             Position of the sub-plot.
         opacity: float, optional
             Transparency of the sub-plot.
+        title: str, optional
+            Title of the sub-plot (only for plots).
         """
         self._graphics_objs.append({**locals()})
 
+    def _all_plt_objs(self):
+        from ansys.fluent.core.post_objects.post_object_definitions import PlotDefn
+
+        for obj in self._graphics_objs:
+            if not isinstance(obj["object"].obj, PlotDefn):
+                return False
+        return True
+
     def show(self) -> None:
         """Render the objects in window and display the same."""
         self.window_id = graphics_windows_manager.open_window(grid=self._grid)
-        self.graphics_window = graphics_windows_manager._post_windows.get(
-            self.window_id
-        )
-        self._renderer = self.graphics_window.renderer
-        self.plotter = self.graphics_window.renderer.plotter
-        for i in range(len(self._graphics_objs)):
-            graphics_windows_manager.add_graphics(
-                object=self._graphics_objs[i]["object"].obj,
-                window_id=self.window_id,
-                fetch_data=True,
-                overlay=True,
-                position=self._graphics_objs[i]["position"],
-                opacity=self._graphics_objs[i]["opacity"],
+        if self._all_plt_objs() and get_config()["blocking"]:
+            p = PlotterWindow(grid=self._grid)
+            for obj in self._graphics_objs:
+                p.add_plots(obj["object"], position=obj["position"], title=obj["title"])
+            p.show(self.window_id)
+        else:
+            self.graphics_window = graphics_windows_manager._post_windows.get(
+                self.window_id
             )
-        graphics_windows_manager.show_graphics(self.window_id)
+            self._renderer = self.graphics_window.renderer
+            self.plotter = self.graphics_window.renderer.plotter
+            for i in range(len(self._graphics_objs)):
+                graphics_windows_manager.add_graphics(
+                    object=self._graphics_objs[i]["object"].obj,
+                    window_id=self.window_id,
+                    fetch_data=True,
+                    overlay=True,
+                    position=self._graphics_objs[i]["position"],
+                    opacity=self._graphics_objs[i]["opacity"],
+                )
+            graphics_windows_manager.show_graphics(self.window_id)
 
     def save_graphic(
         self,