Repository navigation
[Doc]: Create Animation Tutorial #24228
Description
Documentation Link
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
- Animation Classes - brief overview of funcanimation and artist animation1:
- FuncAnimation: most common artist types2:
- Line2D
- PathCollection
- AxesImage
- maybe patches and contours?
- ArtistAnimation
- FuncAnimation: most common artist types2:
- Animation Writers:
- demos of saving a
FuncAnimationand anArtistAnimationwith each - possibly the table of
(writer, file types, dependencies)proposed in [Doc]: clarify which writers animation.save supports #24159 should be here
- demos of saving a
- Advanced Topics:
- Linkout to blitting reference here
Footnotes
-
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 ↩
-
yes this might change if a unified abstraction goes in but that's probably ages out so documenting current state is useful ↩
Activity
chahak13 commentedon Oct 20, 2022
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 commentedon Oct 20, 2022
Absolutely/that'd be awesome/if you want to start sketching out a tutorial go for it!
chahak13 commentedon Oct 20, 2022
Great, thanks! I'll give this a shot
chahak13 commentedon Oct 23, 2022
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 commentedon Oct 24, 2022
I think so, but maybe @dopplershift or @anntzer can confirm?
dopplershift commentedon Oct 24, 2022
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 commentedon Oct 25, 2022
Yes, that's what I meant. Thanks!
chahak13 commentedon Oct 25, 2022
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!