Skip to content

feat: support viz interface#2881

Merged
PProfizi merged 58 commits into
mainfrom
feat/support-viz-interface
Mar 2, 2026
Merged

feat: support viz interface#2881
PProfizi merged 58 commits into
mainfrom
feat/support-viz-interface

Conversation

@moe-ad
Copy link
Copy Markdown
Collaborator

@moe-ad moe-ad commented Jan 5, 2026

Closes #2841.

Summary of changes

  • To prevent direct coupling between the plotter that has to be implemented and viz-interface's plotter backends, we had to propose a couple of backend agnostic customization APIs in the viz-interface. For more context regarding that, see:
  • A _VisualizationInterfacePlotter class has been added. Since viz's PlotlyBackend doesn't support volumetric meshes like the PyVistaBackend does, we are plugging pydpf-core's plotter to only the latter.
  • We still can't deprecate the now legacy _PyVistaPlotter yet, since other classes like Plotter and Animator depends on it. Once those are gradually phased out via separate PRs in the future, we will eventually be able to deprecate _PyVistaPlotter.
  • Because of the previous point, the plotter factory has been parametrized with a plotter_type argument that can be one of PlotterBackend.VISUALIZATION_INTERFACE, PlotterBackend.PYVISTA, and PlotterBackend.AUTO. The behavior is as follows:
    • PlotterBackend.AUTO is the default. This will select the new plotter or the legacy plotter depending on which one is available in the user's environment. This guarantees that plotting scripts won't automatically start breaking if users update pydpf-core without updating it's plotting dependencies.
    • PlotterBackend.PYVISTA will select the legacy plotter and PlotterBackend.VISUALIZATION_INTERFACE will select the new plotter.

@PProfizi and @jorgepiloto, this is now ready for review.

Note

We will address switching to the viz-interface as the default backend in a separate PR. It requires making sure all tests pass and that might require a bit more work.

@moe-ad moe-ad self-assigned this Jan 5, 2026
@codecov
Copy link
Copy Markdown

codecov Bot commented Jan 5, 2026

Codecov Report

❌ Patch coverage is 13.40580% with 239 lines in your changes missing coverage. Please review.
✅ Project coverage is 82.63%. Comparing base (03a7a7c) to head (8ad1baf).
⚠️ Report is 99 commits behind head on main.
✅ All tests successful. No failed tests found.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #2881      +/-   ##
==========================================
- Coverage   84.38%   82.63%   -1.76%     
==========================================
  Files          92       92              
  Lines       10948    11218     +270     
==========================================
+ Hits         9239     9270      +31     
- Misses       1709     1948     +239     

@moe-ad moe-ad marked this pull request as ready for review February 8, 2026 18:51
@moe-ad moe-ad added the deploy-pr-doc For deploying a PR's documentation label Feb 10, 2026
@github-actions
Copy link
Copy Markdown
Contributor

The documentation for this pull request will be available at https://dpf.docs.pyansys.com/pull/2881. Please allow some time for the documentation to be deployed.

@moe-ad moe-ad force-pushed the feat/support-viz-interface branch from 3e6c1a8 to c17da74 Compare March 2, 2026 00:42
@moe-ad moe-ad force-pushed the feat/support-viz-interface branch from 5184748 to 08b6a47 Compare March 2, 2026 02:10
@moe-ad moe-ad force-pushed the feat/support-viz-interface branch from 08b6a47 to dc070de Compare March 2, 2026 02:34
@moe-ad moe-ad force-pushed the feat/support-viz-interface branch from 0b28d0a to 40d7eda Compare March 2, 2026 11:16
@moe-ad moe-ad force-pushed the feat/support-viz-interface branch from 40d7eda to 5b2fa76 Compare March 2, 2026 11:16
Comment thread src/ansys/dpf/core/meshed_region.py
Comment thread src/ansys/dpf/core/plotter.py Outdated
@moe-ad moe-ad force-pushed the feat/support-viz-interface branch from a48e01e to 35f20ac Compare March 2, 2026 14:17
@moe-ad moe-ad force-pushed the feat/support-viz-interface branch from 35f20ac to 8ad1baf Compare March 2, 2026 14:17
@moe-ad moe-ad requested a review from PProfizi March 2, 2026 14:19
@PProfizi PProfizi merged commit 950c7b9 into main Mar 2, 2026
42 of 44 checks passed
@PProfizi PProfizi deleted the feat/support-viz-interface branch March 2, 2026 15:11
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Mar 2, 2026

This PR has been closed. Documentation for this pull request will shortly be removed from its former deployment address.

1 similar comment
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Mar 2, 2026

This PR has been closed. Documentation for this pull request will shortly be removed from its former deployment address.

@PProfizi PProfizi added the enhancement New feature or request label Apr 30, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

deploy-pr-doc For deploying a PR's documentation enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Update plotting modules to support ansys-tools-visualization-interface.

3 participants