FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

DOC: animation faster by jklymak · Pull Request #24918 · matplotlib/matplotlib · GitHub

  1. matplotlib
  2. matplotlib

Repository navigation

DOC: animation faster - #24918

Merged
ksunden merged 3 commits into
matplotlib:mainfrom
jklymak:doc-shorten-animation
Jan 11, 2023
ConversationCommits (3)ChecksFiles changed
Merged

DOC: animation faster#24918
ksunden merged 3 commits into
matplotlib:mainfrom
jklymak:doc-shorten-animation

Conversation

jklymak commented Jan 9, 2023

Copy link
Copy Markdown
Member

PR Summary

The new animation tutorial takes over 30s to render in sphinx gallery on my machine. That seems unnecessary for didactic purposes. This version takes less than 5 s. Maybe someone wants different aesthetics, but this really is pretty slow.

@chahak13 I think you wrote the original. happy to defer to your interest in how this looks, but I still strongly encourage that it be much faster.

PR Checklist

Documentation and Tests

  • Has pytest style unit tests (and pytest passes)
  • Documentation is sphinx and numpydoc compliant (the docs should build without error).
  • New plotting related features are documented with examples.

Release Notes

  • New features are marked with a .. versionadded:: directive in the docstring and documented in doc/users/next_whats_new/
  • API changes are marked with a .. versionchanged:: directive in the docstring and documented in doc/api/next_api_changes/
  • Release notes conform with instructions in next_whats_new/README.rst or next_api_changes/README.rst

tacaswell added this to the v3.7.0 milestone Jan 9, 2023
timhoffm reviewed Jan 9, 2023
View reviewed changes

timhoffm left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

Reducing the number of points is reasonable. However, with that, you only plot in a tiny fraction of the Axes, and the (somewhat complex) x-y relation does not become apparent.
I suggest to change the data as well, e.g. plot 36 points on a unit circle.

jklymak commented Jan 10, 2023

Copy link
Copy Markdown
Member Author

OK, changed this much more to something physical if trivial. Also did things like label the axes etc...

jklymak force-pushed the doc-shorten-animation branch 2 times, most recently from 449a57c to a489512 Compare January 10, 2023 01:06
chahak13 reviewed Jan 10, 2023
View reviewed changes
Comment thread tutorials/introductory/animation_tutorial.py
Comment on lines -104 to -107
# .set_offsets replaces the offset data for the entire collection with
# the new values. Therefore, to also carry forward the previously
# calculated information, we use the data from the first to the current
# frame to set the new offsets.

chahak13 Jan 10, 2023

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

I feel like an explanation about why we take the entire data for the new frame should be there since this is a tutorial. Maybe reword it a little but not remove it completely?

jklymak Jan 10, 2023

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

I changed it a bit. Note I also added comments for the steps where the data was added, which basically says what you are saying in the old text, so I think it's relatively clear? If not, happy to take suggestions.

chahak13 commented Jan 10, 2023

Copy link
Copy Markdown
Contributor

The original idea was to not have something entirely trivial to show how to go about doing slightly more problem based, which is why I did not go for, say a unit circle. I'm happy with the projectile motion example that you added if it's making the doc load much faster :)

jklymak force-pushed the doc-shorten-animation branch from a5535a6 to c14227b Compare January 11, 2023 00:48
ksunden merged commit 66dd732 into matplotlib:main Jan 11, 2023
meeseeksmachine mentioned this pull request Jan 11, 2023
Merged
meeseeksmachine pushed a commit to meeseeksmachine/matplotlib that referenced this pull request Jan 11, 2023
Backport PR matplotlib#24918: DOC: animation faster
53e3c72

jklymak commented Jan 11, 2023

Copy link
Copy Markdown
Member Author

Thanks @ksunden

I think this was important to get in to keep the doc build reasonable. OTOH, @chahak13 or @story645 you are more than welcome to open a new PR to tweak the wording.

jklymak deleted the doc-shorten-animation branch January 11, 2023 21:15
QuLogic added a commit that referenced this pull request Jan 12, 2023
Merge pull request #24949 from meeseeksmachine/auto-backport-of-pr-24…
b64f490 
…918-on-v3.7.x

Backport PR #24918 on branch v3.7.x (DOC: animation faster)
ksunden mentioned this pull request Feb 20, 2023
Merged
6 tasks
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Show hidden characters
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

timhoffm timhoffm left review comments
tacaswell tacaswell approved these changes
ksunden ksunden approved these changes
+1 more reviewer
chahak13 chahak13 left review comments
Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

Documentation

Projects

None yet

Milestone

v3.7.0

Development

Successfully merging this pull request may close these issues.

5 participants

Back | FazBrowse Home | New Git URL