Skip to content

[Doc]: Create Animation Tutorial #24228

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.

Sign up for GitHub

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

Jump to bottom
Closed
story645 opened this issue Oct 20, 2022 · 8 comments · Fixed by #24274
Closed

[Doc]: Create Animation Tutorial #24228

story645 opened this issue Oct 20, 2022 · 8 comments · Fixed by #24274
Labels
Documentation topic: animation
Milestone
v3.7.0

Comments

@story645
Copy link
Member

story645 commented Oct 20, 2022 •
edited
Loading

Documentation Link

https://matplotlib.org/devdocs/tutorials/index.html

Problem

It'd be good to have a one stop animation tutorial that gives an overview of the different animation methods and different writers. This overlaps with #19520 and #24159 and advocated for in #22374

Mostly opened this issue so we could maybe hash out a proposed outline & document what folks would want in a tutorial.

Suggested improvement

Tutorial sections

  1. Animation Classes - brief overview of funcanimation and artist animation1:
    1. FuncAnimation: most common artist types2:
      1. Line2D
      2. PathCollection
      3. AxesImage
      4. maybe patches and contours?
    2. ArtistAnimation
  2. Animation Writers:
    1. demos of saving a FuncAnimation and an ArtistAnimation with each
    2. possibly the table of (writer, file types, dependencies) proposed in [Doc]: clarify which writers animation.save supports #24159 should be here
  3. Advanced Topics:
    1. Linkout to blitting reference here

Footnotes

  1. I think it's that func takes a function that updates an artist and may or may not return it, while artist takes the list of changed artists? A pro/con table or table of use cases would also maybe be good ↩

  2. yes this might change if a unified abstraction goes in but that's probably ages out so documenting current state is useful ↩
@chahak13
Copy link
Contributor

chahak13 commented Oct 20, 2022 •
edited
Loading

Hi! I've been working on a package that also uses matplotlib's animation module (maige) I've been planning to spend some time in the animation module and can maybe help out with this?

@story645
Copy link
Member Author

Absolutely/that'd be awesome/if you want to start sketching out a tutorial go for it!

@chahak13
Copy link
Contributor

Great, thanks! I'll give this a shot

@chahak13
Copy link
Contributor

Hi, I had a question about this. In pipe-based writer classes, the supported formats will be governed by the utility being used (ffmpeg/imagemagick), since the frames are passed to them directly. Is my understanding right?

@story645
Copy link
Member Author

I think so, but maybe @dopplershift or @anntzer can confirm?

@dopplershift
Copy link
Contributor

Assuming by "supported formats", you mean the final saved animation format (e.g. gif, mp4), then yes, that's controlled by the tool being used.

@chahak13
Copy link
Contributor

Yes, that's what I meant. Thanks!

@chahak13 chahak13 mentioned this issue Oct 25, 2022
Merged
6 tasks
@chahak13
Copy link
Contributor

I've started working on this in #24274. I started out with writing the code for simple animations for different animation classes. I'll add the write-up to it now. My idea is to try and cover at least all the topics mentioned in various issues related to animation module. Let me know if there are any suggestions. Thanks!

@story645 story645 linked a pull request Oct 25, 2022 that will close this issue
Animation Tutorial #24274
Merged
6 tasks
@QuLogic QuLogic added this to the v3.7.0 milestone May 26, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Documentation topic: animation
Projects
None yet
Milestone
v3.7.0
Development

Successfully merging a pull request may close this issue.

Animation Tutorial chahak13/matplotlib
4 participants
@dopplershift @QuLogic @story645 @chahak13