Repository files navigation

An animation engine for explanatory math videos

Manim is an animation engine for explanatory math videos. It's used to create precise animations programmatically, as demonstrated in the videos of3Blue1Brown.

• Installation
• Usage
• Documentation
• Docker
• Help with Manim
• Contributing
• License

Manim requires a few dependencies that must be installed prior to using it. If youwant 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.

Manim is an extremely versatile package. The following is an exampleScene you 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 -ql example.py SquareToCircle

You 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 gallery for more advanced examples.

Manim also ships with a%%manim IPython magic which allows to use it conveniently in JupyterLab (as well as classic Jupyter) notebooks. See thecorresponding documentation for some guidance andtry it out online.

The general usage of Manim is as follows:

The-p flag in the command above is for previewing, meaning the video file will automatically open when it is done rendering. The-ql flag is for a faster rendering at a lower quality.

Some other useful flags include:

• -s to skip to the end and just show the final frame.
• -n <number> to skip ahead to then'th animation of a scene.
• -f show the file in the file browser.

For a thorough list of command line arguments, visit thedocumentation.

Documentation is in progress atReadTheDocs.

The 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.

If you need help installing or using Manim, feel free to reach out to ourDiscordServer orReddit Community. If you would like to submit a bug report or feature request, please open an issue.

Contributions 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 server to discuss any potentialcontributions and keep up to date with the latest developments.

Most developers on the project usepoetry for management. You'll want to have poetry installed and available in your environment.Learn more aboutpoetry at itsdocumentation and find out how to install manim with poetry at themanim dev-installation guide in the manim documentation.

We acknowledge the importance of good software to support research, and we notethat research becomes more valuable when it is communicated effectively. Todemonstrate 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) andclick the "cite this repository" button on the right sidebar. This will generatea citation in your preferred format, and will also integrate well with citation managers.

Our full code of conduct, and how we enforce it, can be read onour website.

The software is double-licensed under the MIT license, with copyright by 3blue1brown LLC (see LICENSE), and copyright by Manim Community Developers (see LICENSE.community).