chore: Update optional dependencies. (#564)

Update optional dependencies.

Author: prmukherj

README.rst

@@ -64,6 +64,19 @@ Install the latest release from `PyPI
 
    pip install ansys-fluent-visualization
 
+There are optional dependencies depending on the desired usage mode.
+To run the plotter in interactive mode, install with:
+
+.. code:: console
+
+   pip install ansys-fluent-visualization[interactive]
+
+For interactive mode with graphics displayed in a single Qt window using multiple tabs, install with:
+
+.. code:: console
+
+   pip install ansys-fluent-visualization[single-window]
+
 Alternatively, install the latest release from `GitHub
 <https://github.com/ansys/pyfluent-visualization>`_ with:
 

pyproject.toml

@@ -28,9 +28,12 @@ importlib-metadata = {version = "^4.0", python = "<3.9"}
 ansys-fluent-core = "~=0.34.0"
 pyvista = ">=0.44.0"
 matplotlib = ">=3.6.0"
-pyvistaqt = "~=0.11.1"
-pyside6 = "~=6.8.1"
-imageio= ">=2.36.1"
+pyvistaqt = { version = "~=0.11.1", optional = true }
+pyside6 = { version = "~=6.8.1", optional = true }
+
+[tool.poetry.extras]
+interactive = ["pyvistaqt"]
+single-window = ["pyvistaqt", "pyside6"]
 
 [tool.poetry.urls]
 "Documentation" = "https://visualization.fluent.docs.pyansys.com/"

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

@@ -21,14 +21,6 @@
 # SOFTWARE.
 
 """A wrapper to improve the user interface of graphics."""
-from PySide6.QtWidgets import (
-    QApplication,
-    QMainWindow,
-    QTabWidget,
-    QVBoxLayout,
-    QWidget,
-)
-
 import ansys.fluent.visualization as pyviz
 from ansys.fluent.visualization.graphics import graphics_windows_manager
 
@@ -61,6 +53,19 @@ def __init__(
         except AttributeError:
             self.plotter = None
         if pyviz.config.single_window:
+            try:
+                from PySide6.QtWidgets import QApplication
+
+                from ansys.fluent.visualization.graphics.single_qt_windows import (
+                    MainWindow,
+                )
+            except ModuleNotFoundError as ex:
+                raise ModuleNotFoundError(
+                    "Missing dependencies, "
+                    "use 'pip install ansys-fluent-visualization[single-window]' "
+                    "to install them."
+                ) from ex
+
             global _qt_window
             if not _qt_window:
                 QApplication.instance() or QApplication()
@@ -176,42 +181,3 @@ def close(
             graphics_windows_manager.close_windows(
                 windows_id=[self.window_id], session_id=session_id
             )
-
-
-# Define the main window
-class MainWindow(QMainWindow):
-    def __init__(self):
-        super().__init__()
-        self.setWindowTitle("PyFluent Visualization Plots")
-        screen = QApplication.primaryScreen().availableGeometry()
-        width = int(screen.width() * 0.75)
-        height = int(screen.height() * 0.75)
-        self.setGeometry(
-            (screen.width() - width) // 2,  # Center X
-            (screen.height() - height) // 2,  # Center Y
-            width,
-            height,
-        )
-        self.tabs = QTabWidget()
-        self.setCentralWidget(self.tabs)
-        self.tabs.setMovable(True)
-        self.plotters = []
-
-    def _add_tab(self, plotter, title="-"):
-        tab = QWidget()
-        layout = QVBoxLayout()
-
-        self.plotters.append(plotter)
-        layout.addWidget(plotter.interactor)
-        tab.setLayout(layout)
-
-        # Add tabs with PyVista BackgroundPlotters
-        self.tabs.addTab(tab, f"PyViz ({title})")
-
-    def closeEvent(self, event):
-        """Ensure proper cleanup of plotter instances on window close."""
-        for plotter in self.plotters:
-            plotter.close()  # Properly close each PyVista plotter
-        event.accept()
-        global _qt_window
-        _qt_window = None

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

@@ -25,7 +25,7 @@
 from enum import Enum
 import itertools
 import threading
-from typing import Dict, List, Optional, Union
+from typing import Dict, List, Optional
 
 import numpy as np
 import pyvista as pv
@@ -36,12 +36,6 @@
     PlotDefn,
 )
 from ansys.fluent.interface.post_objects.singleton_meta import AbstractSingletonMeta
-
-try:
-    from pyvistaqt import BackgroundPlotter
-except ModuleNotFoundError:
-    BackgroundPlotter = None
-
 import ansys.fluent.visualization as pyviz
 from ansys.fluent.visualization.post_data_extractor import (
     FieldDataExtractor,
@@ -691,7 +685,7 @@ def get_window(self, window_id: str) -> GraphicsWindow:
         with self._condition:
             return self._post_windows.get(window_id, None)
 
-    def get_plotter(self, window_id: str) -> Union[BackgroundPlotter, pv.Plotter]:
+    def get_plotter(self, window_id: str):
         """Get the PyVista plotter.
 
         Parameters
@@ -701,8 +695,7 @@ def get_plotter(self, window_id: str) -> Union[BackgroundPlotter, pv.Plotter]:
 
         Returns
         -------
-        Union[BackgroundPlotter, pv.Plotter]
-            PyVista plotter.
+            Plotter.
         """
         with self._condition:
             return self._post_windows[window_id].renderer.plotter

src/ansys/fluent/visualization/graphics/pyvista/renderer.py

@@ -28,8 +28,12 @@
 
 try:
     from pyvistaqt import BackgroundPlotter
-except ModuleNotFoundError:
-    BackgroundPlotter = None
+except ModuleNotFoundError as ex:
+    if pyviz.config.interactive:
+        raise ModuleNotFoundError(
+            "Missing dependencies, "
+            "use 'pip install ansys-fluent-visualization[interactive]' to install them."
+        ) from ex
 
 from ansys.fluent.visualization.base.renderer import AbstractRenderer
 

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

@@ -0,0 +1,70 @@
+# Copyright (C) 2022 - 2025 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.
+"""Module defining qt single window to add graphics."""
+
+from PySide6.QtWidgets import (
+    QApplication,
+    QMainWindow,
+    QTabWidget,
+    QVBoxLayout,
+    QWidget,
+)
+
+
+# Define the main window
+class MainWindow(QMainWindow):
+    def __init__(self):
+        super().__init__()
+        self.setWindowTitle("PyFluent Visualization Plots")
+        screen = QApplication.primaryScreen().availableGeometry()
+        width = int(screen.width() * 0.75)
+        height = int(screen.height() * 0.75)
+        self.setGeometry(
+            (screen.width() - width) // 2,  # Center X
+            (screen.height() - height) // 2,  # Center Y
+            width,
+            height,
+        )
+        self.tabs = QTabWidget()
+        self.setCentralWidget(self.tabs)
+        self.tabs.setMovable(True)
+        self.plotters = []
+
+    def _add_tab(self, plotter, title="-"):
+        tab = QWidget()
+        layout = QVBoxLayout()
+
+        self.plotters.append(plotter)
+        if plotter:
+            layout.addWidget(plotter.interactor)
+        tab.setLayout(layout)
+
+        # Add tabs with PyVista BackgroundPlotters
+        self.tabs.addTab(tab, f"PyViz ({title})")
+
+    def closeEvent(self, event):
+        """Ensure proper cleanup of plotter instances on window close."""
+        for plotter in self.plotters:
+            plotter.close()  # Properly close each PyVista plotter
+        event.accept()
+        global _qt_window
+        _qt_window = None

tests/test_visualization.py

@@ -56,6 +56,8 @@
     XYPlot,
     config,
 )
+
+config.interactive = False
 from ansys.fluent.visualization.graphics.graphics_windows_manager import (
     GraphicsWindow as TGraphicsWindow,
 )
@@ -93,7 +95,6 @@ def test_visualization_calls_render_correctly_with_single_mesh(
     new_solver_session_with_exhaust_case_and_data,
 ):
     with patch.object(Renderer, "render") as mock_render:
-        config.interactive = False
         solver = new_solver_session_with_exhaust_case_and_data
         mesh_surfaces_list = [
             "in1",
@@ -152,7 +153,6 @@ def test_visualization_calls_render_correctly_with_dual_mesh(
     new_solver_session_with_exhaust_case_and_data,
 ):
     with patch.object(Renderer, "render") as mock_render:
-        config.interactive = False
         solver = new_solver_session_with_exhaust_case_and_data
         mesh_surfaces_list = [
             "in1",
@@ -209,7 +209,6 @@ def test_visualization_calls_render_correctly_with_plane_and_iso_surface(
     new_solver_session_with_exhaust_case_and_data,
 ):
     with patch.object(Renderer, "render") as mock_render:
-        config.interactive = False
         solver = new_solver_session_with_exhaust_case_and_data
         TGraphicsWindow.show_graphics = lambda win_id: None
 
@@ -264,7 +263,6 @@ def test_visualization_calls_render_correctly_with_contour(
     new_solver_session_with_exhaust_case_and_data,
 ):
     with patch.object(Renderer, "render") as mock_render:
-        config.interactive = False
         solver = new_solver_session_with_exhaust_case_and_data
         TGraphicsWindow.show_graphics = lambda win_id: None
         contour = Contour(
@@ -301,7 +299,6 @@ def test_visualization_calls_render_correctly_with_vector(
     new_solver_session_with_exhaust_case_and_data,
 ):
     with patch.object(Renderer, "render") as mock_render:
-        config.interactive = False
         solver = new_solver_session_with_exhaust_case_and_data
         TGraphicsWindow.show_graphics = lambda win_id: None
         velocity_vector = Vector(
@@ -334,7 +331,6 @@ def test_visualization_calls_render_correctly_with_pathlines(
     new_solver_session_with_exhaust_case_and_data,
 ):
     with patch.object(Renderer, "render") as mock_render:
-        config.interactive = False
         solver = new_solver_session_with_exhaust_case_and_data
         TGraphicsWindow.show_graphics = lambda win_id: None
         pathlines = Pathline(solver=solver)
@@ -366,7 +362,6 @@ def test_visualization_calls_render_correctly_with_xy_plot_pyvista(
     new_solver_session_with_exhaust_case_and_data,
 ):
     with patch.object(Plotter, "render") as mock_render:
-        config.interactive = False
         solver = new_solver_session_with_exhaust_case_and_data
         TPlotterWindow._show_plot = lambda win_id: None
         xy_plot_object = XYPlot(
@@ -396,7 +391,6 @@ def test_visualization_calls_render_correctly_with_xy_plot_matplotlib(
     new_solver_session_with_exhaust_case_and_data,
 ):
     with patch.object(MatPlotter, "render") as mock_render:
-        config.interactive = False
         solver = new_solver_session_with_exhaust_case_and_data
         TPlotterWindow._show_plot = lambda win_id: None
         xy_plot_object = XYPlot(
@@ -426,7 +420,6 @@ def test_visualization_calls_render_correctly_with_monitor_plot(
     new_solver_session_with_exhaust_case_and_data,
 ):
     with patch.object(Plotter, "render") as mock_render:
-        config.interactive = False
         solver = new_solver_session_with_exhaust_case_and_data
         TPlotterWindow._show_plot = lambda win_id: None
         residual = Monitor(solver=solver)