FIX: Add animation using DPF animate() #1599

GuillemBarroso · 2022-10-31T10:02:35Z

Investigating issue #1579.

🐞 Problem
Locally, the documentation shows the correct animation. However, it looks like it is not able to display it properly in the deployed documentation.

This PR attempts to use the .animate() method from DPF in order to have the animation properly displayed in the documentation.

Changes:

composite_dcb.py:
- Add try except to also accept both local DPF and server DPF.
- Add section with animation using .animate() method.
requrements_docs.txt:
- Upgrade vtk dependency to version 9.2.2. An error was found when pip install -r requrements/requirements_docs.txt complaining about not finding version 9.0.3.

💡 Conclusion
The animation using .animate() is different from the one generated using pv.Plotter(). It only shows the displacements instead of the cohesive damage.

First, we would need to confirm that the .animate() Gif is properly displayed in the documentation. Then, I will create an issue to further investigate how to display the cohesive damage using .animate().

github-actions · 2022-10-31T10:03:56Z

Please add one of the following labels to add this contribution to the Release Notes 👇

codecov · 2022-10-31T10:08:51Z

Codecov Report

Merging #1599 (b93ea29) into main (6fb508e) will increase coverage by 3.39%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##             main    #1599      +/-   ##
==========================================
+ Coverage   79.52%   82.92%   +3.39%     
==========================================
  Files          44       44              
  Lines        7151     7151              
==========================================
+ Hits         5687     5930     +243     
+ Misses       1464     1221     -243

germa89 · 2022-10-31T15:36:39Z

@GuillemBarroso there is something going on with the doc build. It doesn't finish!

GuillemBarroso · 2022-10-31T15:39:08Z

@GuillemBarroso there is something going on with the doc build. It doesn't finish!

Hm... It did finish when I built it locally this morning!

germa89 · 2022-10-31T16:30:18Z

@GuillemBarroso

I dont think it works:

reading sources... [100%] mapdl_commands/solution/load_step_options .. user_guide/xpl

WARNING: Cell printed to stderr:
2022-10-31 16:22:15.349 (   1.457s) [        31A26740]    vtkExtractEdges.cxx:435   INFO| Executing edge extractor: points are renumbered
2022-10-31 16:22:15.373 (   1.481s) [        31A26740]    vtkExtractEdges.cxx:551   INFO| Created 21886 edges

WARNING: Cell printed to stderr:
2022-10-31 16:22:16.085 (   2.193s) [        31A26740]    vtkExtractEdges.cxx:435   INFO| Executing edge extractor: points are renumbered
2022-10-31 16:22:16.108 (   2.216s) [        31A26740]    vtkExtractEdges.cxx:551   INFO| Created 21886 edges

WARNING: Cell printed to stderr:
2022-10-31 16:22:17.386 (   3.494s) [        31A26740]    vtkExtractEdges.cxx:435   INFO| Executing edge extractor: points are renumbered
2022-10-31 16:22:17.521 (   3.629s) [        31A26740]    vtkExtractEdges.cxx:551   INFO| Created 65658 edges

WARNING: Cell printed to stderr:
2022-10-31 16:22:18.784 (   4.892s) [        31A26740]    vtkExtractEdges.cxx:435   INFO| Executing edge extractor: points are renumbered
2022-10-31 16:22:18.854 (   4.962s) [        31A26740]    vtkExtractEdges.cxx:551   INFO| Created 65658 edges

WARNING: Cell printed to stderr:
2022-10-31 16:22:19.539 (   5.647s) [        31A26740]    vtkExtractEdges.cxx:435   INFO| Executing edge extractor: points are renumbered
2022-10-31 16:22:19.627 (   5.735s) [        31A26740]    vtkExtractEdges.cxx:551   INFO| Created 87544 edges

WARNING: Cell printed to stderr:
2022-10-31 16:22:20.357 (   6.465s) [        31A26740]    vtkExtractEdges.cxx:435   INFO| Executing edge extractor: points are renumbered
2022-10-31 16:22:20.461 (   6.569s) [        31A26740]    vtkExtractEdges.cxx:551   INFO| Created 87544 edges

WARNING: Cell printed to stderr:
2022-10-31 16:22:20.678 (   6.786s) [        31A26740]    vtkExtractEdges.cxx:435   INFO| Executing edge extractor: points are renumbered

WARNING: Cell printed to stderr:
2022-10-31 16:22:57.841 (  32.403s) [        79A3D740]    vtkExtractEdges.cxx:435   INFO| Executing edge extractor: points are renumbered
2022-10-31 16:22:57.848 (  32.410s) [        79A3D740]    vtkExtractEdges.cxx:551   INFO| Created 9992 edges

WARNING: Cell printed to stderr:
2022-10-31 16:22:59.260 (  33.822s) [        79A3D740]    vtkExtractEdges.cxx:435   INFO| Executing edge extractor: points are renumbered
2022-10-31 16:22:59.261 (  33.822s) [        79A3D740]    vtkExtractEdges.cxx:551   INFO| Created 222 edges

WARNING: Cell printed to stderr:
2022-10-31 16:22:59.869 (  34.430s) [        79A3D740]    vtkExtractEdges.cxx:435   INFO| Executing edge extractor: points are renumbered
2022-10-31 16:22:59.869 (  34.431s) [        79A3D740]    vtkExtractEdges.cxx:551   INFO| Created 222 edges

WARNING: Cell printed to stderr:
2022-10-31 16:23:00.187 (  34.749s) [        79A3D740]    vtkExtractEdges.cxx:435   INFO| Executing edge extractor: points are renumbered
2022-10-31 16:23:00.188 (  34.749s) [        79A3D740]    vtkExtractEdges.cxx:551   INFO| Created 222 edges

looking for now-outdated files... none found

akaszynski · 2022-10-31T22:37:36Z

WARNING: Cell printed to stderr:
2022-10-31 16:23:00.187 (  34.749s) [        79A3D740]    vtkExtractEdges.cxx:435   INFO| Executing edge extractor: points are renumbered
2022-10-31 16:23:00.188 (  34.749s) [        79A3D740]    vtkExtractEdges.cxx:551   INFO| Created 222 edges

These warnings were added in VTK 9.2.2 and are harmless. PyVista needs to suppress these by adding an option in extract_edges to warn if edges are renumbered.

examples/00-mapdl-examples/composite_dcb.py

germa89 · 2022-10-31T22:46:13Z

WARNING: Cell printed to stderr:
2022-10-31 16:23:00.187 (  34.749s) [        79A3D740]    vtkExtractEdges.cxx:435   INFO| Executing edge extractor: points are renumbered
2022-10-31 16:23:00.188 (  34.749s) [        79A3D740]    vtkExtractEdges.cxx:551   INFO| Created 222 edges
These warnings were added in VTK 9.2.2 and are harmless. PyVista needs to suppress these by adding an option in extract_edges to warn if edges are renumbered.

So I guess it should be fixed upstream.

By the way, we should probably consider upgrading VTK. @GuillemBarroso realised we are a couple of releases behind. Maybe when Pyvista fixes the warnings??

akaszynski · 2022-10-31T22:53:45Z

I've only seen that in the latest VTK v9.2.2

Let me check the workflows to see which one is getting installed.

akaszynski · 2022-10-31T22:56:53Z

Yea, it's vtk==9.0.3, which is weird, at least in the docs build.

Either something changed upstream (and pyvista hasn't made a new release lately), or we need to fix something.

Depending on how annoying it is, we can get a patch release out soon. About to finally drop a minor release.

GuillemBarroso · 2022-11-01T08:01:28Z

When I tried to install the doc dependencies with pip install -r requirements/requirements_docs.txt I got the following error:

That is why I checked, and I found that the latest version was 9.2.2. Although I find it weird that it cannot find a previous stable version such as the 9.0.3.

germa89 · 2022-11-02T13:12:42Z

When I tried to install the doc dependencies with pip install -r requirements/requirements_docs.txt I got the following error:

Have you used a newly created python env??

germa89 · 2022-11-02T13:13:46Z

After plenty of re-runs, now it works. It didn't make sense to fail.

There are some merge conflicts which after fixed will re-trigger the workflows... let's see if we are more lucky now.

germa89

LGTM. Good job @GuillemBarroso !

examples/00-mapdl-examples/composite_dcb.py

GuillemBarroso · 2022-11-02T14:15:36Z

When I tried to install the doc dependencies with pip install -r requirements/requirements_docs.txt I got the following error:

Have you used a newly created python env??

Yes! I always do. Just in case I have tried again, and I get the same message: "No matching distribution found for vtk==9.0.3"

akaszynski · 2022-11-02T14:32:43Z

That is why I checked, and I found that the latest version was 9.2.2. Although I find it weird that it cannot find a previous stable version such as the 9.0.3.

It's there on PyPI. I bet your issue is the release doesn't have a Python 3.10 wheel. See:
https://pypi.org/project/vtk/9.0.3/#files

germa89 · 2022-11-02T14:34:36Z

@GuillemBarroso if you are using conda just create a new python environment using conda env create --name mynewenv python=3.9.

Co-authored-by: German <28149841+germa89@users.noreply.github.com>

GuillemBarroso · 2022-11-02T15:02:22Z

@GuillemBarroso if you are using conda just create a new python environment using conda env create --name mynewenv python=3.9.

Thanks @germa89. I was using Python venv as recommended in the dev guide.

Now I have just installed conda and I was able to install the doc requirements. Thanks.

…mapdl into fix/animation-example

Add animation using animate + use local DPF + upgrade vtk dependency

9a479e4

github-actions bot added Dependencies Documentation Documentation related (improving, adding, etc) BUG Issue, problem or error in PyMAPDL labels Oct 31, 2022

GuillemBarroso and others added 2 commits October 31, 2022 11:11

Fix style

d61155a

Adding connect to server

db99a4b

resetting cache

ca179ca

github-actions bot added CI/CD Related with CICD, Github Actions, etc Maintenance General maintenance of the repo (libraries, cicd, etc) labels Oct 31, 2022

germa89 added 2 commits October 31, 2022 23:00

undoing vtk

9d5e6e6

Adding missing role.

d3d02c8

akaszynski reviewed Oct 31, 2022

View reviewed changes

examples/00-mapdl-examples/composite_dcb.py Outdated Show resolved Hide resolved

fix low qual image

af9d7a0

Merge branch 'main' into fix/animation-example

b92e0f0

germa89 approved these changes Nov 2, 2022

View reviewed changes

examples/00-mapdl-examples/composite_dcb.py Show resolved Hide resolved

examples/00-mapdl-examples/composite_dcb.py Outdated Show resolved Hide resolved

reset cache

89077b5

Update examples/00-mapdl-examples/composite_dcb.py

34d5cf9

Co-authored-by: German <28149841+germa89@users.noreply.github.com>

GuillemBarroso and others added 3 commits November 3, 2022 09:40

reset cache

8bb3a56

Merge branch 'fix/animation-example' of https://github.com/pyansys/py…

87039fa

…mapdl into fix/animation-example

Fixing the doc building because of new pyvista version

b93ea29

GuillemBarroso merged commit 3145975 into main Nov 4, 2022

GuillemBarroso deleted the fix/animation-example branch November 4, 2022 10:19

GuillemBarroso mentioned this pull request Nov 4, 2022

Bug when rendering animation using PyVista #1614

Closed

3 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

FIX: Add animation using DPF animate() #1599

FIX: Add animation using DPF animate() #1599

GuillemBarroso commented Oct 31, 2022

github-actions bot commented Oct 31, 2022

codecov bot commented Oct 31, 2022 •

edited

germa89 commented Oct 31, 2022

GuillemBarroso commented Oct 31, 2022

germa89 commented Oct 31, 2022

akaszynski commented Oct 31, 2022

germa89 commented Oct 31, 2022

akaszynski commented Oct 31, 2022

akaszynski commented Oct 31, 2022

GuillemBarroso commented Nov 1, 2022

germa89 commented Nov 2, 2022

germa89 commented Nov 2, 2022

germa89 left a comment

GuillemBarroso commented Nov 2, 2022

akaszynski commented Nov 2, 2022

germa89 commented Nov 2, 2022

GuillemBarroso commented Nov 2, 2022

FIX: Add animation using DPF animate() #1599

FIX: Add animation using DPF animate() #1599

Conversation

GuillemBarroso commented Oct 31, 2022

github-actions bot commented Oct 31, 2022

codecov bot commented Oct 31, 2022 • edited

Codecov Report

germa89 commented Oct 31, 2022

GuillemBarroso commented Oct 31, 2022

germa89 commented Oct 31, 2022

akaszynski commented Oct 31, 2022

germa89 commented Oct 31, 2022

akaszynski commented Oct 31, 2022

akaszynski commented Oct 31, 2022

GuillemBarroso commented Nov 1, 2022

germa89 commented Nov 2, 2022

germa89 commented Nov 2, 2022

germa89 left a comment

Choose a reason for hiding this comment

GuillemBarroso commented Nov 2, 2022

akaszynski commented Nov 2, 2022

germa89 commented Nov 2, 2022

GuillemBarroso commented Nov 2, 2022

codecov bot commented Oct 31, 2022 •

edited