Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adding dynamic plots in documentation #2241

Draft
wants to merge 42 commits into
base: main
Choose a base branch
from
Draft

Conversation

clatapie
Copy link
Contributor

Closes #2177.

@clatapie clatapie self-assigned this Aug 11, 2023
@clatapie clatapie linked an issue Aug 11, 2023 that may be closed by this pull request
@codecov
Copy link

codecov bot commented Aug 11, 2023

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 86.92%. Comparing base (853daba) to head (5482de7).
Report is 3 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #2241      +/-   ##
==========================================
- Coverage   86.93%   86.92%   -0.02%     
==========================================
  Files         187      187              
  Lines       14616    14619       +3     
==========================================
+ Hits        12707    12708       +1     
- Misses       1909     1911       +2     
---- 🚨 Try these New Features:

@clatapie
Copy link
Contributor Author

clatapie commented Aug 11, 2023

The following warning appears only one figure per output is supported for now when using the dynamic plotting.

EDIT: This can probably be modified as this example shows more than one dynamic figure

@clatapie
Copy link
Contributor Author

The pyansys-math PR will be used as an example to implement it within PyMAPDL as there are some issues that are not solved for now.

Copy link
Collaborator

@germa89 germa89 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Some questions need to be addressed, later please request another review.

doc/source/conf.py Outdated Show resolved Hide resolved
doc/source/conf.py Outdated Show resolved Hide resolved
pyproject.toml Outdated Show resolved Hide resolved
@github-actions
Copy link
Contributor

github-actions bot commented Oct 5, 2023

Hello! 👋

Your PR is changing the image cache. So I am attaching the new image cache
in a new commit.

This commit does not re-run the CICD workflows (since no changes are made in the codebase) therefore
you will see the actions showing in their status Expected — Waiting for status to be reported. Do not worry.
You commit workflow is still running here 😄

You might want to rerun the test to make sure that everything is passing. You can retrigger the CICD sending an empty commit git commit -m "Empty comment to trigger CICD" --allow-empty.

You will see this message everytime your commit changes the image cache but you are not attaching the updated cache. 🤓

@github-actions
Copy link
Contributor

github-actions bot commented Oct 9, 2023

Hello! 👋

Your PR is changing the image cache. So I am attaching the new image cache
in a new commit.

This commit does not re-run the CICD workflows (since no changes are made in the codebase) therefore
you will see the actions showing in their status Expected — Waiting for status to be reported. Do not worry.
You commit workflow is still running here 😄

You might want to rerun the test to make sure that everything is passing. You can retrigger the CICD sending an empty commit git commit -m "Empty comment to trigger CICD" --allow-empty.

You will see this message everytime your commit changes the image cache but you are not attaching the updated cache. 🤓

@github-actions
Copy link
Contributor

github-actions bot commented Oct 9, 2023

Hello! 👋

Your PR is changing the image cache. So I am attaching the new image cache
in a new commit.

This commit does not re-run the CICD workflows (since no changes are made in the codebase) therefore
you will see the actions showing in their status Expected — Waiting for status to be reported. Do not worry.
You commit workflow is still running here 😄

You might want to rerun the test to make sure that everything is passing. You can retrigger the CICD sending an empty commit git commit -m "Empty comment to trigger CICD" --allow-empty.

You will see this message everytime your commit changes the image cache but you are not attaching the updated cache. 🤓

@clatapie
Copy link
Contributor Author

pyvista.DynamicScrapper doesn't correctly render for PyMAPDL for now because:

  • there are different plots for 1 output and it's not yet accepted by the scrapper - easy to fix
  • some .gif are generated - need to be investigated

@clatapie
Copy link
Contributor Author

Pinging @AlejandroFernandezLuces for visibility.

@AlejandroFernandezLuces
Copy link
Contributor

Christos is currently working in improving interactive documentation plotters. Here is his PR in case you want to try it out: pyvista/pyvista#4938

pyproject.toml Outdated Show resolved Hide resolved
@germa89
Copy link
Collaborator

germa89 commented Apr 1, 2024

@clatapie can you write up a summarise of this PR situation?

@AlejandroFernandezLuces
Copy link
Contributor

pyvista.DynamicScrapper doesn't correctly render for PyMAPDL for now because:

  • there are different plots for 1 output and it's not yet accepted by the scrapper - easy to fix
  • some .gif are generated - need to be investigated

Now the first one shouldn't happen, I've had to remove subplots from examples to adapt to the new visualization tool. Let me know if you need any help with this PR 🙂

@germa89
Copy link
Collaborator

germa89 commented Nov 25, 2024

Re-attempting this....

@github-actions github-actions bot added the documentation Documentation related (improving, adding, etc) label Nov 25, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Documentation related (improving, adding, etc)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add dynamic plots in documentation
5 participants