From 301001532abd84b89c4398a01fdff19ab14fe615 Mon Sep 17 00:00:00 2001 From: afernand Date: Wed, 22 May 2024 15:05:31 +0200 Subject: [PATCH 1/7] fix: Add proper behaviour in show method --- .../backends/pyvista/pyvista.py | 3 -- .../tools/visualization_interface/plotter.py | 31 +++++++++++++++++-- 2 files changed, 28 insertions(+), 6 deletions(-) diff --git a/src/ansys/tools/visualization_interface/backends/pyvista/pyvista.py b/src/ansys/tools/visualization_interface/backends/pyvista/pyvista.py index fd2c06b9..2f85cf47 100644 --- a/src/ansys/tools/visualization_interface/backends/pyvista/pyvista.py +++ b/src/ansys/tools/visualization_interface/backends/pyvista/pyvista.py @@ -500,6 +500,3 @@ def plot(self, object: Any, filter: str = None, **plotting_options): else: self.pv_interface.plot(object, filter, **plotting_options) - def show(self): - """Show the rendered scene.""" - self.pv_interface.show() diff --git a/src/ansys/tools/visualization_interface/plotter.py b/src/ansys/tools/visualization_interface/plotter.py index 958f2676..f66ecaee 100644 --- a/src/ansys/tools/visualization_interface/plotter.py +++ b/src/ansys/tools/visualization_interface/plotter.py @@ -56,6 +56,31 @@ def plot(self, object: Any, **plotting_options): """ self._backend.plot(object=object, **plotting_options) - def show(self): - """Show the plotted objects.""" - self._backend.show() + def show( + self, + object: Any = None, + screenshot: str = None, + view_2d: bool = None, + filter: bool = None, + **plotting_options + ) -> None: + """Show the plotted objects. + + Parameters + ---------- + object : Any, optional + Object to show, by default None. + screenshot : str, optional + Path to save a screenshot, by default None. + view_2d : bool, optional + Flag to show the object in 2D, by default None. + filter : bool, optional + Flag to filter the object, by default None. + """ + self._backend.show( + object=object, + screenshot=screenshot, + view_2d=view_2d, + filter=filter, + **plotting_options + ) From aafe90d5f71860cf19e308c84c021e2c3efba63e Mon Sep 17 00:00:00 2001 From: afernand Date: Wed, 22 May 2024 15:44:06 +0200 Subject: [PATCH 2/7] fix: Remove view_2d parameter --- src/ansys/tools/visualization_interface/plotter.py | 4 ---- 1 file changed, 4 deletions(-) diff --git a/src/ansys/tools/visualization_interface/plotter.py b/src/ansys/tools/visualization_interface/plotter.py index f66ecaee..2c9265f4 100644 --- a/src/ansys/tools/visualization_interface/plotter.py +++ b/src/ansys/tools/visualization_interface/plotter.py @@ -60,7 +60,6 @@ def show( self, object: Any = None, screenshot: str = None, - view_2d: bool = None, filter: bool = None, **plotting_options ) -> None: @@ -72,15 +71,12 @@ def show( Object to show, by default None. screenshot : str, optional Path to save a screenshot, by default None. - view_2d : bool, optional - Flag to show the object in 2D, by default None. filter : bool, optional Flag to filter the object, by default None. """ self._backend.show( object=object, screenshot=screenshot, - view_2d=view_2d, filter=filter, **plotting_options ) From eb8c248ff4c8176c938f0303d39bf4e892765407 Mon Sep 17 00:00:00 2001 From: afernand Date: Wed, 22 May 2024 16:21:53 +0200 Subject: [PATCH 3/7] fix: Add missing parameter doc --- src/ansys/tools/visualization_interface/plotter.py | 2 ++ 1 file changed, 2 insertions(+) diff --git a/src/ansys/tools/visualization_interface/plotter.py b/src/ansys/tools/visualization_interface/plotter.py index 2c9265f4..e02bc95d 100644 --- a/src/ansys/tools/visualization_interface/plotter.py +++ b/src/ansys/tools/visualization_interface/plotter.py @@ -73,6 +73,8 @@ def show( Path to save a screenshot, by default None. filter : bool, optional Flag to filter the object, by default None. + plotting_options : dict + Additional plotting options the selected backend accepts. """ self._backend.show( object=object, From 575308582bc81880f7cf97a292a2656d93dcda0a Mon Sep 17 00:00:00 2001 From: afernand Date: Wed, 22 May 2024 17:38:17 +0200 Subject: [PATCH 4/7] fix: Off screen mode --- .../backends/pyvista/pyvista_interface.py | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/src/ansys/tools/visualization_interface/backends/pyvista/pyvista_interface.py b/src/ansys/tools/visualization_interface/backends/pyvista/pyvista_interface.py index 3587c6c2..8499763b 100644 --- a/src/ansys/tools/visualization_interface/backends/pyvista/pyvista_interface.py +++ b/src/ansys/tools/visualization_interface/backends/pyvista/pyvista_interface.py @@ -74,7 +74,8 @@ def __init__( # Generate custom scene if ``None`` is provided if scene is None: scene = pv.Plotter(plotter_kwargs) - + if TESTING_MODE: + scene.off_screen = True # If required, use a white background with no gradient if not color_opts: color_opts = dict(color="white") From 1104dd199fb0d561b77687f2e356873eabc9d98f Mon Sep 17 00:00:00 2001 From: afernand Date: Mon, 27 May 2024 13:33:47 +0200 Subject: [PATCH 5/7] fix: Add setuptools dependency --- pyproject.toml | 1 + 1 file changed, 1 insertion(+) diff --git a/pyproject.toml b/pyproject.toml index 332c1239..1774daf9 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -26,6 +26,7 @@ dependencies = [ "pyvista >= 0.42.0,<1", "beartype >= 0.17.0,<1", "websockets >= 12.0,<13", + "setuptools >= 70.0.0,<71", "trame >= 3.6.0,<4", "trame-vtk >= 2.8.7,<3", "trame-vuetify >= 2.4.3,<3", From 050c86524baec412f1d71dae07d483bd39dc72bd Mon Sep 17 00:00:00 2001 From: afernand Date: Mon, 27 May 2024 15:11:07 +0200 Subject: [PATCH 6/7] fix: __Version__ --- pyproject.toml | 7 +++---- src/ansys/tools/visualization_interface/__init__.py | 5 ++--- 2 files changed, 5 insertions(+), 7 deletions(-) diff --git a/pyproject.toml b/pyproject.toml index 1f07d839..332c1239 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -26,7 +26,6 @@ dependencies = [ "pyvista >= 0.42.0,<1", "beartype >= 0.17.0,<1", "websockets >= 12.0,<13", - "setuptools >= 70.0.0,<71", "trame >= 3.6.0,<4", "trame-vtk >= 2.8.7,<3", "trame-vuetify >= 2.4.3,<3", @@ -35,15 +34,15 @@ dependencies = [ [project.optional-dependencies] tests = ["pytest==8.2.1", "pytest-pyvista==0.1.9", "pytest-cov==5.0.0"] doc = [ - "ansys-sphinx-theme==0.16.2", + "ansys-sphinx-theme==0.15.2", "jupyter_sphinx==0.5.3", "jupytext==1.16.2", "nbsphinx==0.9.4", "numpydoc==1.7.0", "sphinx==7.3.7", - "sphinx-autoapi==3.1.1", + "sphinx-autoapi==3.1.0b0", "sphinx-copybutton==0.5.2", - "sphinx_design==0.6.0", + "sphinx_design==0.5.0", "sphinx-gallery==0.16.0", "sphinx-jinja==2.0.2", ] diff --git a/src/ansys/tools/visualization_interface/__init__.py b/src/ansys/tools/visualization_interface/__init__.py index 12fcb96e..ca4341b6 100644 --- a/src/ansys/tools/visualization_interface/__init__.py +++ b/src/ansys/tools/visualization_interface/__init__.py @@ -20,11 +20,10 @@ # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE # SOFTWARE. """Visualization Interface Tool is a Python client library for visualizing the results of Ansys simulations.""" +import importlib.metadata as importlib_metadata import os -import pkg_resources - -__version__ = pkg_resources.get_distribution("ansys-tools-visualization-interface").version +__version__ = importlib_metadata.version(__name__.replace(".", "-")) USE_TRAME: bool = False DOCUMENTATION_BUILD: bool = False From 8cd5ddbc887366dc6b4d8897a09ea3556cb49da3 Mon Sep 17 00:00:00 2001 From: afernand Date: Mon, 27 May 2024 15:21:30 +0200 Subject: [PATCH 7/7] fix: Modified dependencies --- pyproject.toml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/pyproject.toml b/pyproject.toml index 332c1239..ffd57162 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -34,15 +34,15 @@ dependencies = [ [project.optional-dependencies] tests = ["pytest==8.2.1", "pytest-pyvista==0.1.9", "pytest-cov==5.0.0"] doc = [ - "ansys-sphinx-theme==0.15.2", + "ansys-sphinx-theme==0.16.2", "jupyter_sphinx==0.5.3", "jupytext==1.16.2", "nbsphinx==0.9.4", "numpydoc==1.7.0", "sphinx==7.3.7", - "sphinx-autoapi==3.1.0b0", + "sphinx-autoapi==3.1.1", "sphinx-copybutton==0.5.2", - "sphinx_design==0.5.0", + "sphinx_design==0.6.0", "sphinx-gallery==0.16.0", "sphinx-jinja==2.0.2", ]