Package: manim
An animation engine for explanatory math videosManim is an animation engine for explanatory math videos. It's used to create precise animations programmatically, as demonstrated in the videos of3Blue1Brown.NOTE: This repository is maintained by the Manim Community and is not associated with Grant Sanderson or 3Blue1Brown in any way (although we are definitely indebted to him for providing his work to the world). If you would like to study how Grant makes his videos, head over to his repository (3b1b/manim). This fork is updated more frequently than his, and it's recommended to use this fork if you'd like to use Manim for your own projects.Table of Contents:InstallationUsageDocumentationDockerHelp with ManimContributingLicenseInstallationWARNING:These instructions are for the community versiononly. Trying to use these instructions to install3b1b/manimor instructions there to install this version will cause problems. Readthisand decide which version you wish to install, then only follow the instructions for your desired version.Manim requires a few dependencies that must be installed prior to using it. If you
want to try it out first before installing it locally, you can do soin our online Jupyter environment.For local installation, please visit theDocumentationand follow the appropriate instructions for your operating system.UsageManim is an extremely versatile package. The following is an exampleSceneyou can construct:frommanimimport*classSquareToCircle(Scene):defconstruct(self):circle=Circle()square=Square()square.flip(RIGHT)square.rotate(-3*TAU/8)circle.set_fill(PINK,opacity=0.5)self.play(Create(square))self.play(Transform(square,circle))self.play(FadeOut(square))In order to view the output of this scene, save the code in a file calledexample.py. Then, run the following in a terminal window:manim-p-qlexample.pySquareToCircleYou should see your native video player program pop up and play a simple scene in which a square is transformed into a circle. You may find some more simple examples within thisGitHub repository. You can also visit theofficial galleryfor more advanced examples.Manim also ships with a%%manimIPython magic which allows to use it conveniently in JupyterLab (as well as classic Jupyter) notebooks. See thecorresponding documentationfor some guidance andtry it out online.Command line argumentsThe general usage of Manim is as follows:The-pflag in the command above is for previewing, meaning the video file will automatically open when it is done rendering. The-qlflag is for a faster rendering at a lower quality.Some other useful flags include:-sto skip to the end and just show the final frame.-n <number>to skip ahead to then'th animation of a scene.-fshow the file in the file browser.For a thorough list of command line arguments, visit thedocumentation.DocumentationDocumentation is in progress atReadTheDocs.DockerThe community also maintains a docker image (manimcommunity/manim), which can be foundon DockerHub.
Instructions on how to install and use it can be found in ourdocumentation.Help with ManimIf you need help installing or using Manim, feel free to reach out to ourDiscord
ServerorReddit Community. If you would like to submit a bug report or feature request, please open an issue.ContributingContributions to Manim are always welcome. In particular, there is a dire need for tests and documentation. For contribution guidelines, please see thedocumentation.However, please note that Manim is currently undergoing a major refactor. In general,
contributions implementing new features will not be accepted in this period.
The contribution guide may become outdated quickly; we highly recommend joining ourDiscord serverto discuss any potential
contributions and keep up to date with the latest developments.Most developers on the project usepoetryfor management. You'll want to have poetry installed and available in your environment.
Learn more aboutpoetryat itsdocumentationand find out how to install manim with poetry at themanim dev-installation guidein the manim documentation.How to Cite ManimWe acknowledge the importance of good software to support research, and we note
that research becomes more valuable when it is communicated effectively. To
demonstrate the value of Manim, we ask that you cite Manim in your work.
Currently, the best way to cite Manim is to go to ourrepository page(if you aren't already) and
click the "cite this repository" button on the right sidebar. This will generate
a citation in your preferred format, and will also integrate well with citation managers.Code of ConductOur full code of conduct, and how we enforce it, can be read onour website.LicenseThe software is double-licensed under the MIT license, with copyright by 3blue1brown LLC (see LICENSE), and copyright by Manim Community Developers (see LICENSE.community).