You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Manim is an animation engine for explanatory math videos. It's used to create precise animations programmatically, as seen in the videos at [3Blue1Brown](https://www.3blue1brown.com/).
10
-
11
-
> NOTE: This repository is maintained by the Manim Community, and is not associated with Grant Sanderson or 3Blue1Brown in any way (though we are definitely indebted to him for providing his work to the world). If you want to study how Grant makes his videos, head over to his repository (3b1b/manim). This is a more frequently updated repository than that one, and is recommended if you want to use Manim for your own projects.
<i>An animation engine for explanatory math videos</i>
13
+
</p>
14
+
15
+
<hr />
16
+
17
+
`manim` is an animation engine for explanatory math videos. It's used to create precise animations programmatically, as demonstrated in the videos of [3Blue1Brown](https://www.3blue1brown.com/).
18
+
19
+
> 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](https://github.com/3b1b/manim)). This fork is updated more frequently than that his, and it's recommended to use this fork if you'd like to use Manim for your own projects.
12
20
13
21
## Table of Contents:
14
22
15
-
-[Installation](#installation)
16
-
-[Usage](#usage)
17
-
-[Documentation](#documentation)
18
-
-[Help with Manim](#help-with-manim)
19
-
-[Contributing](#contributing)
20
-
-[License](#license)
23
+
-[Installation](#installation)
24
+
-[Usage](#usage)
25
+
-[Documentation](#documentation)
26
+
-[Help with Manim](#help-with-manim)
27
+
-[Contributing](#contributing)
28
+
-[License](#license)
21
29
22
30
## Installation
23
31
24
-
Manim has a few dependencies that need to be installed before it. Please visit
and follow the instructions according to your operating system.
32
+
Manim requires a few dependencies that must be installed prior to using it. Please visit the [documentation](https://manimce.readthedocs.io/en/latest/installation.html) and follow the appropriate instructions for your operating system.
33
+
34
+
Once the dependencies have been installed, run the following in a terminal window:
35
+
36
+
```bash
37
+
pip install manimce
38
+
```
28
39
29
40
## Usage
30
41
31
-
Here is an example manim script:
42
+
Manim is an extremely versatile package. The following is an example `Scene` you can construct:
32
43
33
44
```python
34
45
from manim import*
@@ -46,56 +57,46 @@ class SquareToCircle(Scene):
46
57
self.play(FadeOut(square))
47
58
```
48
59
49
-
Save this code in a file called `example.py`. Now open your terminal in the
50
-
folder where you saved the file and execute
60
+
In order to view the output of this scene, save the code in a file called `example.py`. Then, run the following in a terminal window:
51
61
52
62
```sh
53
-
manim example.py SquareToCircle -pl
63
+
manim example.py SquareToCircle -p -ql
54
64
```
55
65
56
-
You should see your video player pop up and play a simple scene where a square
57
-
is transformed into a circle. You can find some more simple examples in the
Visit the [official gallery](https://manimce.readthedocs.io/en/latest/examples.html) for more advanced examples.
66
+
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 this
67
+
[GitHub repository](master/example_scenes). You can also visit the [official gallery](https://manimce.readthedocs.io/en/latest/examples.html) for more advanced examples.
The `-p` flag in the command above is for previewing, meaning the video file will automatically open when it is done rendering. The `-l` flag is for a faster rendering at a lower quality.
75
+
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.
68
76
69
77
Some other useful flags include:
70
78
71
-
-`-s` to skip to the end and just show the final frame.
72
-
-`-n <number>` to skip ahead to the `n`'th animation of a scene.
73
-
-`-f` show the file in the file browser.
79
+
-`-s` to skip to the end and just show the final frame.
80
+
-`-n <number>` to skip ahead to the `n`'th animation of a scene.
81
+
-`-f` show the file in the file browser.
74
82
75
-
For a thorough list of command line arguments, visit the
For a thorough list of command line arguments, visit the [documentation](https://manimce.readthedocs.io/en/latest/tutorials/configuration.html).
77
84
78
85
## Documentation
79
86
80
87
Documentation is in progress at [ReadTheDocs](https://manimce.readthedocs.io/en/latest/).
81
88
82
89
## Help with Manim
83
90
84
-
If you need help installing or using Manim, please take a look at [the Reddit
85
-
Community](https://www.reddit.com/r/manim) or the [Discord
86
-
Community](https://discord.gg/mMRrZQW). For bug reports and feature requests,
87
-
please open an issue.
91
+
If you need help installing or using Manim, feel free to reach out to our [Discord
92
+
Server](https://discord.gg/mMRrZQW) or [Reddit Community](https://www.reddit.com/r/manim). If you would like to submit bug report or feature request, please open an issue.
88
93
89
94
## Contributing
90
95
91
-
Is always welcome. In particular, there is a dire need for tests and
This project uses [Poetry](https://python-poetry.org/docs/) for management. You need to have poetry installed and available in your environment.
95
-
You can find more information about it in its [Documentation](https://manimce.readthedocs.io/en/latest/installation/for_dev.html)
96
+
Contributions to `manim` are always welcome. In particular, there is a dire need for tests and documentation. For contribution guidelines, please see the [documentation](https://manimce.readthedocs.io/en/latest/contributing.html).
97
+
98
+
This project uses [Poetry](https://python-poetry.org/docs/) for management. You must have poetry installed and available in your environment. You can learn more `poetry` and how to use it at its [Documentation](https://manimce.readthedocs.io/en/latest/installation/for_dev.html).
96
99
97
100
## License
98
101
99
-
The software is double-licensed under the MIT license, with copyright
100
-
by 3blue1brown LLC (see LICENSE), and copyright by Manim Community
101
-
Developers (see LICENSE.community).
102
+
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).
self.add(triangle, square, circle, ds_m) # Order matters
77
+
self.wait()
78
+
79
+
Download the resource for the following example `here <https://github.com/ManimCommunity/manim/blob/master/docs/source/_static/manim-logo-sidebar.svg>`_
0 commit comments