diff --git a/docs/source/documentation/custom_default.rst b/docs/source/documentation/custom_config.rst similarity index 93% rename from docs/source/documentation/custom_default.rst rename to docs/source/documentation/custom_config.rst index 554d1fa2..496c87a9 100644 --- a/docs/source/documentation/custom_default.rst +++ b/docs/source/documentation/custom_config.rst @@ -1,4 +1,4 @@ -custom_default +custom_config ============== ``directories`` @@ -18,12 +18,13 @@ custom_default file and saved the last frame, then the final directory structure will be like: .. code-block:: text - :emphasize-lines: 8, 10 + :emphasize-lines: 9, 11 manim/ ├── manimlib/ │ ├── animation/ │ ├── ... + │ ├── default_config.yml │ └── window.py ├── output/ │ ├── images @@ -31,18 +32,18 @@ custom_default │ └── videos │ └── Scene1.mp4 ├── code.py - ├── custom_default.yml - └── manim.py + └── custom_config.yml But if you set ``mirror_module_path`` to ``True``, the directory structure will be: .. code-block:: text - :emphasize-lines: 7 + :emphasize-lines: 8 manim/ ├── manimlib/ │ ├── animation/ │ ├── ... + │ ├── default_config.yml │ └── window.py ├── output/ │ └── code/ @@ -51,8 +52,7 @@ custom_default │ └── videos │ └── Scene1.mp4 ├── code.py - ├── custom_default.yml - └── manim.py + └── custom_config.yml - ``raster_images`` The directory for storing raster images to be used in the code (including diff --git a/docs/source/getting_started/configuration.rst b/docs/source/getting_started/configuration.rst index f0947097..17319bb1 100644 --- a/docs/source/getting_started/configuration.rst +++ b/docs/source/getting_started/configuration.rst @@ -4,14 +4,16 @@ CLI flags and configuration 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: .. code-block:: sh - python manim.py .py + manimgl .py + # or + manim-render .py -- ``.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. +- ``.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. - ```` : 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. - ```` : CLI flags. @@ -48,6 +50,7 @@ flag abbr function ``--write_all`` ``-a`` Write all the scenes from a file ``--open`` ``-o`` Automatically open the saved file once its done ``--finder`` Show the output file in finder +``--config`` Guide for automatic configuration ``--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. ``--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 ========================================================== ====== ================================================================================================================================================================================================= -custom_default +custom_config -------------- 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), -you can modify ``custom_default.yml``. The meaning of each option is in -page :doc:`../documentation/custom_default`. +you can modify ``custom_config.yml``. The meaning of each option is in +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: .. code-block:: text @@ -74,13 +77,13 @@ following the directory structure: ├── manimlib/ │ ├── animation/ │ ├── ... + │ ├── default_config.yml │ └── window.py ├── project/ │ ├── code.py - │ └── custom_default.yml - ├── custom_default.yml - └── manim.py + │ └── custom_config.yml + └── custom_config.yml -When you enter the ``project/`` folder and run ``python ../manim.py code.py ``, -it will overwrite ``manim/custom_default.yml`` with ``custom_default.yml`` +When you enter the ``project/`` folder and run ``manimgl code.py ``, +it will overwrite ``manim/custom_config.yml`` with ``custom_config.yml`` in the ``project`` folder. \ No newline at end of file diff --git a/docs/source/getting_started/example_scenes.rst b/docs/source/getting_started/example_scenes.rst index efc6c16c..5f9d1f33 100644 --- a/docs/source/getting_started/example_scenes.rst +++ b/docs/source/getting_started/example_scenes.rst @@ -11,7 +11,7 @@ SquareToCircle .. manim-example:: SquareToCircle :media: ../_static/example_scenes/SquareToCircle.mp4 - from manimlib.imports import * + from manimlib import * class SquareToCircle(Scene): def construct(self): diff --git a/docs/source/getting_started/installation.rst b/docs/source/getting_started/installation.rst index 06253786..62f95885 100644 --- a/docs/source/getting_started/installation.rst +++ b/docs/source/getting_started/installation.rst @@ -55,15 +55,6 @@ For Anaconda git clone https://github.com/3b1b/manim.git cd manim - conda env create -f environment.yml - -Using virtualenv and virtualenvwrapper --------------------------------------- - -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 \ No newline at end of file + conda create -n manim python=3.8 + conda activate manim + pip install -e . \ No newline at end of file diff --git a/docs/source/getting_started/quickstart.rst b/docs/source/getting_started/quickstart.rst index 4299b24b..09313889 100644 --- a/docs/source/getting_started/quickstart.rst +++ b/docs/source/getting_started/quickstart.rst @@ -14,9 +14,9 @@ directory structure: ├── manimlib/ │ ├── animation/ │ ├── ... + │ ├── default_config.yml │ └── window.py - ├── custom_default.yml - ├── manim.py + ├── custom_config.yml └── start.py 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 :linenos: - from manimlib.imports import * + from manimlib import * class SquareToCircle(Scene): def construct(self): @@ -38,7 +38,7 @@ And run this command: .. 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 : @@ -53,7 +53,7 @@ Run this command again: .. 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 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 - from manimlib.imports import * + from manimlib import * 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 :linenos: - from manimlib.imports import * + from manimlib import * class SquareToCircle(Scene): def construct(self): @@ -147,14 +147,14 @@ Run this command this time: .. 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 it into a circle. If you want to save this video, run: .. 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 ``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() -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 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 - python manim.py + manimgl You succeeded! -------------- diff --git a/docs/source/getting_started/structure.rst b/docs/source/getting_started/structure.rst index 5bb92d49..f45165ff 100644 --- a/docs/source/getting_started/structure.rst +++ b/docs/source/getting_started/structure.rst @@ -12,107 +12,105 @@ Below is the directory structure of manim: .. code-block:: text - ├── manim.py # Manim command entry - ├── custom_default.yml # Default configuration - └── manimlib/ # manim library - ├── __init__.py # run from here - ├── config.py # Process CLI flags - ├── constants.py # Defined some constants - ├── extract_scene.py # Extract and run the scene - ├── imports.py # Import all required files in manimlib - ├── shader_wrapper.py # Shaders' Wrapper for convenient control - ├── window.py # Playback window - ├── tex_templates/ # Templates preset for LaTeX - │ ├── tex_templates.tex # Tex template (will be compiled with latex, default) - │ └── ctex_templates.tex # Tex template that support Chinese (will be compiled with xelatex) - ├── camera/ - │ └── camera.py # Including Camera and CameraFrame - ├── scene/ - │ ├── scene_file_writer.py # Used to write scene to video file - │ ├── scene.py # The basic Scene class - │ ├── three_d_scene.py # Three-dimensional scene - │ ├── graph_scene.py # GraphScene (with coordinate axis) - │ ├── reconfigurable_scene.py - │ ├── sample_space_scene.py # Probability related sample space scene - │ └── vector_space_scene.py # Vector field scene - ├── animation/ - │ ├── animation.py # The basic class of animation - │ ├── composition.py # Animation group - │ ├── creation.py # Animation related to Create - │ ├── fading.py # Fade related animation - │ ├── growing.py # Animation related to Grow - │ ├── indication.py # Some animations for emphasis - │ ├── movement.py # Animation related to movement - │ ├── numbers.py # Realize changes to DecimalNumber - │ ├── rotation.py # Animation related to rotation - │ ├── specialized.py # Some uncommon animations for special projects - │ ├── transform_matching_parts.py # Transform which can automatically match parts - │ ├── transform.py # Some Transforms - │ └── update.py # Realize update from function - ├── mobject/ - │ ├── mobject.py # The basic class of all math object - │ ├── types/ # 4 types of mobject - │ │ ├── dot_cloud.py # Dot cloud (an subclass of PMobject) - │ │ ├── image_mobject.py # Insert pictures - │ │ ├── point_cloud_mobject.py # PMobject (mobject composed of points) - │ │ ├── surface.py # ParametricSurface - │ │ └── vectorized_mobject.py # VMobject (vectorized mobject) - │ ├── svg/ # mobject related to svg - │ │ ├── svg_mobject.py # SVGMobject - │ │ ├── brace.py # Brace - │ │ ├── drawings.py # Some special mobject of svg image - │ │ ├── tex_mobject.py # Tex and TexText implemented by LaTeX - │ │ └── text_mobject.py # Text implemented by cairo - │ ├── changing.py # Dynamically changing mobject - │ ├── coordinate_systems.py # coordinate system - │ ├── frame.py # mobject related to frame - │ ├── functions.py # ParametricFunction - │ ├── geometry.py # geometry mobjects - │ ├── matrix.py # matrix - │ ├── mobject_update_utils.py # some defined updater - │ ├── number_line.py # Number line - │ ├── numbers.py # Numbers that can be changed - │ ├── probability.py # mobject related to probability - │ ├── shape_matchers.py # mobject adapted to the size of other objects - │ ├── three_dimensions.py # Three-dimensional objects - │ ├── value_tracker.py # ValueTracker which storage number - │ └── vector_field.py # VectorField - ├── once_useful_constructs/ # 3b1b's Common scenes written for some videos - │ └── ... - ├── shaders/ # GLSL scripts for rendering - │ ├── simple_vert.glsl # a simple glsl script for position - │ ├── insert/ # glsl scripts to be inserted in other glsl scripts - │ │ ├── NOTE.md # explain how to insert glsl scripts - │ │ └── ... # useful scripts - │ ├── image/ # glsl for images - │ │ └── ... # containing shaders for vertex and fragment - │ ├── quadratic_bezier_fill/ # glsl for the fill of quadratic bezier curve - │ │ └── ... # containing shaders for vertex, fragment and geometry - │ ├── quadratic_bezier_stroke/ # glsl for the stroke of quadratic bezier curve - │ │ └── ... # containing shaders for vertex, fragment and geometry - │ ├── surface/ # glsl for surfaces - │ │ └── ... # containing shaders for vertex and fragment - │ ├── textured_surface/ # glsl for textured_surface - │ │ └── ... # containing shaders for vertex and fragment - │ └── true_dot/ # glsl for a dot - │ └── ... # containing shaders for vertex, fragment and geometry - └── utils/ # Some useful utility functions - ├── bezier.py # For bezier curve - ├── color.py # For color - ├── config_ops.py # Process CONFIG - ├── customization.py # Read from custom_default.yml - ├── debug.py # Utilities for debugging in program - ├── family_ops.py # Process family members - ├── file_ops.py # Process files and directories - ├── images.py # Read image - ├── iterables.py # Functions related to list/dictionary processing - ├── paths.py # Curve path - ├── rate_functions.py # Some defined rate_functions - ├── simple_functions.py # Some commonly used functions - ├── sounds.py # Process sounds - ├── space_ops.py # Space coordinate calculation - ├── strings.py # Process strings - └── tex_file_writing.py # Use LaTeX to write strings as svg + manimlib/ # manim library + ├── __init__.py + ├── __main__.py + ├── default_config.yml # Default configuration file + ├── config.py # Process CLI flags + ├── constants.py # Defined some constants + ├── extract_scene.py # Extract and run the scene + ├── shader_wrapper.py # Shaders' Wrapper for convenient control + ├── window.py # Playback window + ├── tex_templates/ # Templates preset for LaTeX + │ ├── tex_templates.tex # Tex template (will be compiled with latex, default) + │ └── ctex_templates.tex # Tex template that support Chinese (will be compiled with xelatex) + ├── camera/ + │ └── camera.py # Including Camera and CameraFrame + ├── scene/ + │ ├── scene_file_writer.py # Used to write scene to video file + │ ├── scene.py # The basic Scene class + │ ├── three_d_scene.py # Three-dimensional scene + │ ├── sample_space_scene.py # Probability related sample space scene + │ └── vector_space_scene.py # Vector field scene + ├── animation/ + │ ├── animation.py # The basic class of animation + │ ├── composition.py # Animation group + │ ├── creation.py # Animation related to Create + │ ├── fading.py # Fade related animation + │ ├── growing.py # Animation related to Grow + │ ├── indication.py # Some animations for emphasis + │ ├── movement.py # Animation related to movement + │ ├── numbers.py # Realize changes to DecimalNumber + │ ├── rotation.py # Animation related to rotation + │ ├── specialized.py # Some uncommon animations for special projects + │ ├── transform_matching_parts.py # Transform which can automatically match parts + │ ├── transform.py # Some Transforms + │ └── update.py # Realize update from function + ├── mobject/ + │ ├── mobject.py # The basic class of all math object + │ ├── types/ # 4 types of mobject + │ │ ├── dot_cloud.py # Dot cloud (an subclass of PMobject) + │ │ ├── image_mobject.py # Insert pictures + │ │ ├── point_cloud_mobject.py # PMobject (mobject composed of points) + │ │ ├── surface.py # ParametricSurface + │ │ └── vectorized_mobject.py # VMobject (vectorized mobject) + │ ├── svg/ # mobject related to svg + │ │ ├── svg_mobject.py # SVGMobject + │ │ ├── brace.py # Brace + │ │ ├── drawings.py # Some special mobject of svg image + │ │ ├── tex_mobject.py # Tex and TexText implemented by LaTeX + │ │ └── text_mobject.py # Text implemented by cairo + │ ├── changing.py # Dynamically changing mobject + │ ├── coordinate_systems.py # coordinate system + │ ├── frame.py # mobject related to frame + │ ├── functions.py # ParametricFunction + │ ├── geometry.py # geometry mobjects + │ ├── matrix.py # matrix + │ ├── mobject_update_utils.py # some defined updater + │ ├── number_line.py # Number line + │ ├── numbers.py # Numbers that can be changed + │ ├── probability.py # mobject related to probability + │ ├── shape_matchers.py # mobject adapted to the size of other objects + │ ├── three_dimensions.py # Three-dimensional objects + │ ├── value_tracker.py # ValueTracker which storage number + │ └── vector_field.py # VectorField + ├── once_useful_constructs/ # 3b1b's Common scenes written for some videos + │ └── ... + ├── shaders/ # GLSL scripts for rendering + │ ├── simple_vert.glsl # a simple glsl script for position + │ ├── insert/ # glsl scripts to be inserted in other glsl scripts + │ │ ├── NOTE.md # explain how to insert glsl scripts + │ │ └── ... # useful scripts + │ ├── image/ # glsl for images + │ │ └── ... # containing shaders for vertex and fragment + │ ├── quadratic_bezier_fill/ # glsl for the fill of quadratic bezier curve + │ │ └── ... # containing shaders for vertex, fragment and geometry + │ ├── quadratic_bezier_stroke/ # glsl for the stroke of quadratic bezier curve + │ │ └── ... # containing shaders for vertex, fragment and geometry + │ ├── surface/ # glsl for surfaces + │ │ └── ... # containing shaders for vertex and fragment + │ ├── textured_surface/ # glsl for textured_surface + │ │ └── ... # containing shaders for vertex and fragment + │ └── true_dot/ # glsl for a dot + │ └── ... # containing shaders for vertex, fragment and geometry + └── utils/ # Some useful utility functions + ├── bezier.py # For bezier curve + ├── color.py # For color + ├── config_ops.py # Process CONFIG + ├── customization.py # Read from custom_config.yml + ├── debug.py # Utilities for debugging in program + ├── family_ops.py # Process family members + ├── file_ops.py # Process files and directories + ├── images.py # Read image + ├── init_config.py # Configuration guide + ├── iterables.py # Functions related to list/dictionary processing + ├── paths.py # Curve path + ├── rate_functions.py # Some defined rate_functions + ├── simple_functions.py # Some commonly used functions + ├── sounds.py # Process sounds + ├── space_ops.py # Space coordinate calculation + ├── strings.py # Process strings + └── tex_file_writing.py # Use LaTeX to write strings as svg Inheritance structure of manim's classes ---------------------------------------- diff --git a/docs/source/index.rst b/docs/source/index.rst index 84df7151..14cc0157 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -24,7 +24,7 @@ And here is a Chinese version of this documentation: https://manim.ml/shaders :caption: Documentation documentation/constants - documentation/custom_default + documentation/custom_config .. toctree:: :maxdepth: 2