opensource/manim
1
0
Fork 0
mirror of https://github.com/3b1b/manim.git synced 2025-07-28 12:32:36 +08:00
Code Issues Packages Projects Releases Wiki Activity

update docs

Browse Source
This commit is contained in:
Tony031218
2021-02-08 12:04:29 +08:00
parent f0cbc0571f
commit 24d9d9e45d
7 changed files with 137 additions and 145 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
docs/source/documentation/custom_default.rst → docs/source/documentation/custom_config.rst
View File

@ -1,4 +1,4 @@
custom_default custom_config
============== ==============
``directories`` ``directories``
@ -18,12 +18,13 @@ custom_default
file and saved the last frame, then the final directory structure will be like: file and saved the last frame, then the final directory structure will be like:
.. code-block:: text .. code-block:: text
:emphasize-lines: 8, 10 :emphasize-lines: 9, 11
manim/ manim/
├── manimlib/ ├── manimlib/
│ ├── animation/ │ ├── animation/
│ ├── ... │ ├── ...
│ ├── default_config.yml
│ └── window.py │ └── window.py
├── output/ ├── output/
│ ├── images │ ├── images
@ -31,18 +32,18 @@ custom_default
│ └── videos │ └── videos
│ └── Scene1.mp4 │ └── Scene1.mp4
├── code.py ├── code.py
├── custom_default.yml └── custom_config.yml
└── manim.py
But if you set ``mirror_module_path`` to ``True``, the directory structure will be: But if you set ``mirror_module_path`` to ``True``, the directory structure will be:
.. code-block:: text .. code-block:: text
:emphasize-lines: 7 :emphasize-lines: 8
manim/ manim/
├── manimlib/ ├── manimlib/
│ ├── animation/ │ ├── animation/
│ ├── ... │ ├── ...
│ ├── default_config.yml
│ └── window.py │ └── window.py
├── output/ ├── output/
│ └── code/ │ └── code/
@ -51,8 +52,7 @@ custom_default
│ └── videos │ └── videos
│ └── Scene1.mp4 │ └── Scene1.mp4
├── code.py ├── code.py
├── custom_default.yml └── custom_config.yml
└── manim.py
- ``raster_images`` - ``raster_images``
The directory for storing raster images to be used in the code (including The directory for storing raster images to be used in the code (including

27
docs/source/getting_started/configuration.rst
View File

@ -4,14 +4,16 @@ CLI flags and configuration
Command Line Interface Command Line Interface
---------------------- ----------------------
To run manim, you need to enter the directory at the same level as ``manim.py`` To run manim, you need to enter the directory at the same level as ``manimlib/``
and enter the command in the following format into terminal: and enter the command in the following format into terminal:
.. code-block:: sh .. code-block:: sh
python manim.py <code>.py <Scene> <flags> manimgl <code>.py <Scene> <flags>
# or
manim-render <code>.py <Scene> <flags>
- ``<code>.py`` : The python file you wrote. Needs to be at the same level as ``manim.py``, otherwise you need to use an absolute path or a relative path. - ``<code>.py`` : The python file you wrote. Needs to be at the same level as ``manimlib/``, otherwise you need to use an absolute path or a relative path.
- ``<Scene>`` : The scene you want to render here. If it is not written or written incorrectly, it will list all for you to choose. And if there is only one ``Scene`` in the file, this class will be rendered directly. - ``<Scene>`` : The scene you want to render here. If it is not written or written incorrectly, it will list all for you to choose. And if there is only one ``Scene`` in the file, this class will be rendered directly.
- ``<flags>`` : CLI flags. - ``<flags>`` : CLI flags.
@ -48,6 +50,7 @@ flag abbr function
``--write_all`` ``-a`` Write all the scenes from a file ``--write_all`` ``-a`` Write all the scenes from a file
``--open`` ``-o`` Automatically open the saved file once its done ``--open`` ``-o`` Automatically open the saved file once its done
``--finder`` Show the output file in finder ``--finder`` Show the output file in finder
``--config`` Guide for automatic configuration
``--file_name FILE_NAME`` Name for the movie or image file ``--file_name FILE_NAME`` Name for the movie or image file
``--start_at_animation_number START_AT_ANIMATION_NUMBER`` ``-n`` Start rendering not from the first animation, but from another, specified by its index. If you passin two comma separated values, e.g. "3,6", it will end the rendering at the second value. ``--start_at_animation_number START_AT_ANIMATION_NUMBER`` ``-n`` Start rendering not from the first animation, but from another, specified by its index. If you passin two comma separated values, e.g. "3,6", it will end the rendering at the second value.
``--resolution RESOLUTION`` ``-r`` Resolution, passed as "WxH", e.g. "1920x1080" ``--resolution RESOLUTION`` ``-r`` Resolution, passed as "WxH", e.g. "1920x1080"
@ -57,15 +60,15 @@ flag abbr function
``--video_dir VIDEO_DIR`` directory to write video ``--video_dir VIDEO_DIR`` directory to write video
========================================================== ====== ================================================================================================================================================================================================= ========================================================== ====== =================================================================================================================================================================================================
custom_default custom_config
-------------- --------------
In order to perform more configuration (about directories, etc.) and permanently In order to perform more configuration (about directories, etc.) and permanently
change the default value (you don't have to add flags to the command every time), change the default value (you don't have to add flags to the command every time),
you can modify ``custom_default.yml``. The meaning of each option is in you can modify ``custom_config.yml``. The meaning of each option is in
page :doc:`../documentation/custom_default`. page :doc:`../documentation/custom_config`.
You can also use different ``custom_default.yml`` for different directories, such as You can also use different ``custom_config.yml`` for different directories, such as
following the directory structure: following the directory structure:
.. code-block:: text .. code-block:: text
@ -74,13 +77,13 @@ following the directory structure:
├── manimlib/ ├── manimlib/
│ ├── animation/ │ ├── animation/
│ ├── ... │ ├── ...
│ ├── default_config.yml
│ └── window.py │ └── window.py
├── project/ ├── project/
│ ├── code.py │ ├── code.py
│ └── custom_default.yml │ └── custom_config.yml
├── custom_default.yml └── custom_config.yml
└── manim.py
When you enter the ``project/`` folder and run ``python ../manim.py code.py <Scene>``, When you enter the ``project/`` folder and run ``manimgl code.py <Scene>``,
it will overwrite ``manim/custom_default.yml`` with ``custom_default.yml`` it will overwrite ``manim/custom_config.yml`` with ``custom_config.yml``
in the ``project`` folder. in the ``project`` folder.

2
docs/source/getting_started/example_scenes.rst
View File

@ -11,7 +11,7 @@ SquareToCircle
.. manim-example:: SquareToCircle .. manim-example:: SquareToCircle
:media: ../_static/example_scenes/SquareToCircle.mp4 :media: ../_static/example_scenes/SquareToCircle.mp4
from manimlib.imports import * from manimlib import *
class SquareToCircle(Scene): class SquareToCircle(Scene):
def construct(self): def construct(self):

15
docs/source/getting_started/installation.rst
View File

@ -55,15 +55,6 @@ For Anaconda
git clone https://github.com/3b1b/manim.git git clone https://github.com/3b1b/manim.git
cd manim cd manim
conda env create -f environment.yml conda create -n manim python=3.8
conda activate manim
Using virtualenv and virtualenvwrapper pip install -e .
--------------------------------------
After installing ``virtualenv`` and ``virtualenvwrapper``
.. code-block:: sh
git clone https://github.com/3b1b/manim.git
mkvirtualenv -a manim -r requirements.txt manim
python -m manim example_scenes.py OpeningManimExample

22
docs/source/getting_started/quickstart.rst
View File

@ -14,9 +14,9 @@ directory structure:
├── manimlib/ ├── manimlib/
│ ├── animation/ │ ├── animation/
│ ├── ... │ ├── ...
│ ├── default_config.yml
│ └── window.py │ └── window.py
├── custom_default.yml ├── custom_config.yml
├── manim.py
└── start.py └── start.py
And paste the following code (I will explain the function of each line in detail later): And paste the following code (I will explain the function of each line in detail later):
@ -24,7 +24,7 @@ And paste the following code (I will explain the function of each line in detail
.. code-block:: python .. code-block:: python
:linenos: :linenos:
from manimlib.imports import * from manimlib import *
class SquareToCircle(Scene): class SquareToCircle(Scene):
def construct(self): def construct(self):
@ -38,7 +38,7 @@ And run this command:
.. code-block:: sh .. code-block:: sh
python manim.py start.py SquareToCircle manimgl start.py SquareToCircle
A window will pop up on the screen. And then you can : A window will pop up on the screen. And then you can :
@ -53,7 +53,7 @@ Run this command again:
.. code-block:: sh .. code-block:: sh
python manim.py start.py SquareToCircle -os manimgl start.py SquareToCircle -os
At this time, no window will pop up. When the program is finished, this rendered At this time, no window will pop up. When the program is finished, this rendered
image will be automatically opened (saved in the subdirectory ``images/`` of the same image will be automatically opened (saved in the subdirectory ``images/`` of the same
@ -71,7 +71,7 @@ Next, let's take a detailed look at what each row does.
.. code-block:: python .. code-block:: python
from manimlib.imports import * from manimlib import *
This will import all the classes that may be used when using manim. This will import all the classes that may be used when using manim.
@ -129,7 +129,7 @@ Let's change some codes and add some animations to make videos instead of just p
.. code-block:: python .. code-block:: python
:linenos: :linenos:
from manimlib.imports import * from manimlib import *
class SquareToCircle(Scene): class SquareToCircle(Scene):
def construct(self): def construct(self):
@ -147,14 +147,14 @@ Run this command this time:
.. code-block:: sh .. code-block:: sh
python manim.py start.py SquareToCircle manimgl start.py SquareToCircle
The pop-up window will play animations of drawing a square and transforming The pop-up window will play animations of drawing a square and transforming
it into a circle. If you want to save this video, run: it into a circle. If you want to save this video, run:
.. code-block:: sh .. code-block:: sh
python manim.py start.py SquareToCircle -ow manimgl start.py SquareToCircle -ow
This time there will be no pop-up window, but the video file (saved in the subdirectory This time there will be no pop-up window, but the video file (saved in the subdirectory
``videos/`` of the same level directory of ``start.py`` by default) will be automatically ``videos/`` of the same level directory of ``start.py`` by default) will be automatically
@ -209,7 +209,7 @@ at the end of the code to enable interaction:
self.embed() self.embed()
Then run ``python manim.py start.py SquareToCircle``. Then run ``manimgl start.py SquareToCircle``.
After the previous animation is executed, the ipython terminal will be opened on After the previous animation is executed, the ipython terminal will be opened on
the command line. After that, you can continue to write code in it, and the statement the command line. After that, you can continue to write code in it, and the statement
@ -245,7 +245,7 @@ empty scene containing only ``self.embed()``, you can directly run the following
.. code-block:: sh .. code-block:: sh
python manim.py manimgl
You succeeded! You succeeded!
-------------- --------------

200
docs/source/getting_started/structure.rst
View File

@ -12,107 +12,105 @@ Below is the directory structure of manim:
.. code-block:: text .. code-block:: text
├── manim.py # Manim command entry manimlib/ # manim library
├── custom_default.yml # Default configuration ├── __init__.py
└── manimlib/ # manim library ├── __main__.py
├── __init__.py # run from here ├── default_config.yml # Default configuration file
├── config.py # Process CLI flags ├── config.py # Process CLI flags
├── constants.py # Defined some constants ├── constants.py # Defined some constants
├── extract_scene.py # Extract and run the scene ├── extract_scene.py # Extract and run the scene
├── imports.py # Import all required files in manimlib ├── shader_wrapper.py # Shaders' Wrapper for convenient control
├── shader_wrapper.py # Shaders' Wrapper for convenient control ├── window.py # Playback window
├── window.py # Playback window ├── tex_templates/ # Templates preset for LaTeX
├── tex_templates/ # Templates preset for LaTeX │ ├── tex_templates.tex # Tex template (will be compiled with latex, default)
│ ├── tex_templates.tex # Tex template (will be compiled with latex, default) │ └── ctex_templates.tex # Tex template that support Chinese (will be compiled with xelatex)
│ └── ctex_templates.tex # Tex template that support Chinese (will be compiled with xelatex) ├── camera/
├── camera/ │ └── camera.py # Including Camera and CameraFrame
│ └── camera.py # Including Camera and CameraFrame ├── scene/
├── scene/ │ ├── scene_file_writer.py # Used to write scene to video file
│ ├── scene_file_writer.py # Used to write scene to video file │ ├── scene.py # The basic Scene class
│ ├── scene.py # The basic Scene class │ ├── three_d_scene.py # Three-dimensional scene
│ ├── three_d_scene.py # Three-dimensional scene │ ├── sample_space_scene.py # Probability related sample space scene
│ ├── graph_scene.py # GraphScene (with coordinate axis) │ └── vector_space_scene.py # Vector field scene
│ ├── reconfigurable_scene.py ├── animation/
│ ├── sample_space_scene.py # Probability related sample space scene │ ├── animation.py # The basic class of animation
│ └── vector_space_scene.py # Vector field scene │ ├── composition.py # Animation group
├── animation/ │ ├── creation.py # Animation related to Create
│ ├── animation.py # The basic class of animation │ ├── fading.py # Fade related animation
│ ├── composition.py # Animation group │ ├── growing.py # Animation related to Grow
│ ├── creation.py # Animation related to Create │ ├── indication.py # Some animations for emphasis
│ ├── fading.py # Fade related animation │ ├── movement.py # Animation related to movement
│ ├── growing.py # Animation related to Grow │ ├── numbers.py # Realize changes to DecimalNumber
│ ├── indication.py # Some animations for emphasis │ ├── rotation.py # Animation related to rotation
│ ├── movement.py # Animation related to movement │ ├── specialized.py # Some uncommon animations for special projects
│ ├── numbers.py # Realize changes to DecimalNumber │ ├── transform_matching_parts.py # Transform which can automatically match parts
│ ├── rotation.py # Animation related to rotation │ ├── transform.py # Some Transforms
│ ├── specialized.py # Some uncommon animations for special projects │ └── update.py # Realize update from function
│ ├── transform_matching_parts.py # Transform which can automatically match parts ├── mobject/
│ ├── transform.py # Some Transforms │ ├── mobject.py # The basic class of all math object
│ └── update.py # Realize update from function │ ├── types/ # 4 types of mobject
├── mobject/ │ │ ├── dot_cloud.py # Dot cloud (an subclass of PMobject)
│ ├── mobject.py # The basic class of all math object │ │ ├── image_mobject.py # Insert pictures
│ ├── types/ # 4 types of mobject │ │ ├── point_cloud_mobject.py # PMobject (mobject composed of points)
│ │ ├── dot_cloud.py # Dot cloud (an subclass of PMobject) │ │ ├── surface.py # ParametricSurface
│ │ ├── image_mobject.py # Insert pictures │ │ └── vectorized_mobject.py # VMobject (vectorized mobject)
│ │ ├── point_cloud_mobject.py # PMobject (mobject composed of points) │ ├── svg/ # mobject related to svg
│ │ ├── surface.py # ParametricSurface │ │ ├── svg_mobject.py # SVGMobject
│ │ └── vectorized_mobject.py # VMobject (vectorized mobject) │ │ ├── brace.py # Brace
│ ├── svg/ # mobject related to svg │ │ ├── drawings.py # Some special mobject of svg image
│ │ ├── svg_mobject.py # SVGMobject │ │ ├── tex_mobject.py # Tex and TexText implemented by LaTeX
│ │ ├── brace.py # Brace │ │ └── text_mobject.py # Text implemented by cairo
│ │ ├── drawings.py # Some special mobject of svg image │ ├── changing.py # Dynamically changing mobject
│ │ ├── tex_mobject.py # Tex and TexText implemented by LaTeX │ ├── coordinate_systems.py # coordinate system
│ │ └── text_mobject.py # Text implemented by cairo │ ├── frame.py # mobject related to frame
│ ├── changing.py # Dynamically changing mobject │ ├── functions.py # ParametricFunction
│ ├── coordinate_systems.py # coordinate system │ ├── geometry.py # geometry mobjects
│ ├── frame.py # mobject related to frame │ ├── matrix.py # matrix
│ ├── functions.py # ParametricFunction │ ├── mobject_update_utils.py # some defined updater
│ ├── geometry.py # geometry mobjects │ ├── number_line.py # Number line
│ ├── matrix.py # matrix │ ├── numbers.py # Numbers that can be changed
│ ├── mobject_update_utils.py # some defined updater │ ├── probability.py # mobject related to probability
│ ├── number_line.py # Number line │ ├── shape_matchers.py # mobject adapted to the size of other objects
│ ├── numbers.py # Numbers that can be changed │ ├── three_dimensions.py # Three-dimensional objects
│ ├── probability.py # mobject related to probability │ ├── value_tracker.py # ValueTracker which storage number
│ ├── shape_matchers.py # mobject adapted to the size of other objects │ └── vector_field.py # VectorField
│ ├── three_dimensions.py # Three-dimensional objects ├── once_useful_constructs/ # 3b1b's Common scenes written for some videos
│ ├── value_tracker.py # ValueTracker which storage number │ └── ...
│ └── vector_field.py # VectorField ├── shaders/ # GLSL scripts for rendering
├── once_useful_constructs/ # 3b1b's Common scenes written for some videos │ ├── simple_vert.glsl # a simple glsl script for position
│ └── ... │ ├── insert/ # glsl scripts to be inserted in other glsl scripts
├── shaders/ # GLSL scripts for rendering │ │ ├── NOTE.md # explain how to insert glsl scripts
│ ├── simple_vert.glsl # a simple glsl script for position │ │ └── ... # useful scripts
│ ├── insert/ # glsl scripts to be inserted in other glsl scripts │ ├── image/ # glsl for images
│ │ ├── NOTE.md # explain how to insert glsl scripts │ │ └── ... # containing shaders for vertex and fragment
│ │ └── ... # useful scripts │ ├── quadratic_bezier_fill/ # glsl for the fill of quadratic bezier curve
│ ├── image/ # glsl for images │ │ └── ... # containing shaders for vertex, fragment and geometry
│ │ └── ... # containing shaders for vertex and fragment │ ├── quadratic_bezier_stroke/ # glsl for the stroke of quadratic bezier curve
│ ├── quadratic_bezier_fill/ # glsl for the fill of quadratic bezier curve │ │ └── ... # containing shaders for vertex, fragment and geometry
│ │ └── ... # containing shaders for vertex, fragment and geometry │ ├── surface/ # glsl for surfaces
│ ├── quadratic_bezier_stroke/ # glsl for the stroke of quadratic bezier curve │ │ └── ... # containing shaders for vertex and fragment
│ │ └── ... # containing shaders for vertex, fragment and geometry │ ├── textured_surface/ # glsl for textured_surface
│ ├── surface/ # glsl for surfaces │ │ └── ... # containing shaders for vertex and fragment
│ │ └── ... # containing shaders for vertex and fragment │ └── true_dot/ # glsl for a dot
│ ├── textured_surface/ # glsl for textured_surface │ └── ... # containing shaders for vertex, fragment and geometry
│ │ └── ... # containing shaders for vertex and fragment └── utils/ # Some useful utility functions
│ └── true_dot/ # glsl for a dot ├── bezier.py # For bezier curve
│ └── ... # containing shaders for vertex, fragment and geometry ├── color.py # For color
└── utils/ # Some useful utility functions ├── config_ops.py # Process CONFIG
├── bezier.py # For bezier curve ├── customization.py # Read from custom_config.yml
├── color.py # For color ├── debug.py # Utilities for debugging in program
├── config_ops.py # Process CONFIG ├── family_ops.py # Process family members
├── customization.py # Read from custom_default.yml ├── file_ops.py # Process files and directories
├── debug.py # Utilities for debugging in program ├── images.py # Read image
├── family_ops.py # Process family members ├── init_config.py # Configuration guide
├── file_ops.py # Process files and directories ├── iterables.py # Functions related to list/dictionary processing
├── images.py # Read image ├── paths.py # Curve path
├── iterables.py # Functions related to list/dictionary processing ├── rate_functions.py # Some defined rate_functions
├── paths.py # Curve path ├── simple_functions.py # Some commonly used functions
├── rate_functions.py # Some defined rate_functions ├── sounds.py # Process sounds
├── simple_functions.py # Some commonly used functions ├── space_ops.py # Space coordinate calculation
├── sounds.py # Process sounds ├── strings.py # Process strings
├── space_ops.py # Space coordinate calculation └── tex_file_writing.py # Use LaTeX to write strings as svg
├── strings.py # Process strings
└── tex_file_writing.py # Use LaTeX to write strings as svg
Inheritance structure of manim's classes Inheritance structure of manim's classes
---------------------------------------- ----------------------------------------

2
docs/source/index.rst
View File

@ -24,7 +24,7 @@ And here is a Chinese version of this documentation: https://manim.ml/shaders
:caption: Documentation :caption: Documentation
documentation/constants documentation/constants
documentation/custom_default documentation/custom_config
.. toctree:: .. toctree::
:maxdepth: 2 :maxdepth: 2