Merge branch 'master' into examples_folder_structure

Author: kolibril13

docs/source/examples/plots.rst

@@ -1,6 +1,182 @@
 Plotting with manim
 =================================
 
+Examples to illustrate the use of :class:`.GraphScene` in manim.
+
+
+.. manim:: Plot1
+    :quality: medium
+    :save_last_frame:
+
+    class Plot1(GraphScene):
+        def construct(self):
+            self.setup_axes()
+            func_graph=self.get_graph(lambda x: np.sin(x))
+            self.add(func_graph)
+
+.. manim:: Plot2yLabel
+    :quality: medium
+    :save_last_frame:
+
+    class Plot2yLabel(GraphScene):
+        CONFIG = {
+            "y_min": 0,
+            "y_max": 100,
+            "y_axis_config": {"tick_frequency": 10},
+            "y_labeled_nums": np.arange(0, 100, 10)
+        }
+
+        def construct(self):
+            self.setup_axes(animate=True)
+            dot = Dot().move_to(self.coords_to_point(PI / 2, 20))
+            func_graph = self.get_graph(lambda x: 20 * np.sin(x))
+            self.add(func_graph)
+            self.add(dot)
+
+.. manim:: Plot3DataPoints
+    :quality: medium
+    :save_last_frame:
+
+    class Plot3DataPoints(GraphScene):
+        CONFIG = {
+            "y_axis_label": r"Concentration[\%]",
+            "x_axis_label": "Time [s]",
+            }
+
+        def construct(self):
+            data = [1, 2, 2, 4, 4, 1, 3]
+            self.setup_axes(animate=True)
+            for time, dat in enumerate(data):
+                dot = Dot().move_to(self.coords_to_point(time, dat))
+                self.add(dot)
+
+.. manim:: Plot3bGaussian
+    :quality: medium
+    :save_last_frame:
+
+    amp = 5
+    mu = 3
+    sig = 1
+
+    def gaussian(x):
+        return amp * np.exp((-1 / 2 * ((x - mu) / sig) ** 2))
+
+    class Plot3bGaussian(GraphScene):
+        def construct(self):
+            self.setup_axes()
+            graph = self.get_graph(gaussian, x_min=-1, x_max=10).set_stroke(width=5)
+            self.add(graph)
+
+.. manim:: Plot3cGaussian
+    :quality: medium
+    :save_last_frame:
+
+    class Plot3cGaussian(GraphScene):
+        def construct(self):
+            def gaussian(x):
+                amp = 5
+                mu = 3
+                sig = 1
+                return amp * np.exp((-1 / 2 * ((x - mu) / sig) ** 2))
+            self.setup_axes()
+            graph = self.get_graph(gaussian, x_min=-1, x_max=10).set_style(stroke_width=5, stroke_color=GREEN)
+            self.add(graph)
+
+
+.. manim:: Plot4SinCos
+    :quality: medium
+    :save_last_frame:
+
+    class Plot4SinCos(GraphScene):
+        CONFIG = {
+            "x_min": -10,
+            "x_max": 10.3,
+            "num_graph_anchor_points": 100,
+            "y_min": -1.5,
+            "y_max": 1.5,
+            "graph_origin": ORIGIN,
+            "function_color": RED,
+            "axes_color": GREEN,
+            "x_labeled_nums": range(-10, 12, 2),
+        }
+
+        def construct(self):
+            self.setup_axes(animate=False)
+
+            def func_cos(x):
+                return np.cos(x)
+
+            def func_sin(x):
+                return np.sin(x)
+
+            func_graph = self.get_graph(func_cos, self.function_color)
+            func_graph2 = self.get_graph(func_sin)
+            vert_line = self.get_vertical_line_to_graph(TAU, func_graph, color=YELLOW)
+            graph_lab = self.get_graph_label(func_graph, label="\\cos(x)")
+            graph_lab2 = self.get_graph_label(func_graph2, label="\\sin(x)", x_val=-10, direction=UP / 2)
+            two_pi = MathTex(r"x = 2 \pi")
+            label_coord = self.input_to_graph_point(TAU, func_graph)
+            two_pi.next_to(label_coord, RIGHT + UP)
+            self.add(func_graph, func_graph2, vert_line, graph_lab, graph_lab2, two_pi)
+
+.. manim:: Plot5Area
+    :quality: medium
+    :save_last_frame:
+
+    class Plot5Area(GraphScene):
+        CONFIG = {
+            "x_min" : 0,
+            "x_max" : 5,
+            "y_min" : 0,
+            "y_max" : 6,
+            "y_tick_frequency" : 1,
+            "x_tick_frequency" : 1,
+            "x_labeled_nums" : [0,2,3]
+        }
+        def construct(self):
+            self.setup_axes(animate=False)
+            curve1 = self.get_graph(lambda x : 4*x-x**2, x_min=0,x_max=4)
+            curve2 = self.get_graph(lambda x : 0.8*x**2-3*x+4, x_min=0,x_max=4)
+            line1 = self.get_vertical_line_to_graph(2, curve1, DashedLine, color=YELLOW)
+            line2 = self.get_vertical_line_to_graph(3, curve1, DashedLine, color=YELLOW)
+            area1 = self.get_area(curve1, 0.3, 0.6, dx_scaling=10, area_color=BLUE)
+            area2 = self.get_area(curve2, 2, 3, bounded=curve1)
+            self.add(curve1, curve2, line1, line2, area1, area2)
+
+.. manim:: Plot6HeatDiagram
+    :quality: medium
+    :save_last_frame:
+
+    class Plot6HeatDiagram(GraphScene):
+        CONFIG = {
+            "y_axis_label": r"T[$^\circ C$]",
+            "x_axis_label": r"$\Delta Q$",
+            "y_min": -8,
+            "y_max": 30,
+            "x_min": 0,
+            "x_max": 40,
+            "y_labeled_nums": np.arange(-5, 34, 5),
+            "x_labeled_nums": np.arange(0, 40, 5),
+
+        }
+
+        def construct(self):
+            data = [20, 0, 0, -5]
+            x = [0, 8, 38, 39]
+            self.setup_axes(animate=True)
+            dot_collection = VGroup()
+            for time, val in enumerate(data):
+                dot = Dot().move_to(self.coords_to_point(x[time], val))
+                self.add(dot)
+                dot_collection.add(dot)
+            l1 = Line(dot_collection[0].get_center(), dot_collection[1].get_center())
+            l2 = Line(dot_collection[1].get_center(), dot_collection[2].get_center())
+            l3 = Line(dot_collection[2].get_center(), dot_collection[3].get_center())
+            self.add(l1, l2, l3)
+
+
+The following example illustrates how to draw parametric function plots.
+
 .. manim:: ParamFunc1
     :quality: medium
     :save_last_frame:
@@ -11,4 +187,3 @@ Plotting with manim
        def construct(self):
            func=ParametricFunction(self.func, t_max=TAU, fill_opacity=0).set_color(RED)
            self.add(func.scale(3))
-

docs/source/installation/win.rst

@@ -8,7 +8,7 @@ instructions.
 Installing using Chocolatey
 ***************************
 
-You can install chocolatey very easily using chocolatey. Typing the command install Manim.
+You can install manim very easily using chocolatey, by typing the following command.
 
 
 .. code-block:: powershell

docs/source/manim_directive.py

@@ -5,7 +5,7 @@
 When rendering the HTML documentation, the ``.. manim::`` directive
 implemented here allows to include rendered videos.
 
-Its basic usage that allows processing **inline content** 
+Its basic usage that allows processing **inline content**
 looks as follows::
 
     .. manim:: MyScene
@@ -41,9 +41,9 @@ def construct(self):
 The following configuration options are supported by the
 directive:
 
-    display_source
+    hide_source
         If this flag is present without argument,
-        the source code is displayed above the rendered video.
+        the source code is not displayed above the rendered video.
 
     quality : {'low', 'medium', 'high', 'fourk'}
         Controls render quality of the video, in analogy to
@@ -80,7 +80,7 @@ class ManimDirective(Directive):
     required_arguments = 1
     optional_arguments = 0
     option_spec = {
-        "display_source": bool,
+        "hide_source": bool,
         "quality": lambda arg: directives.choice(
             arg, ("low", "medium", "high", "fourk")
         ),
@@ -100,7 +100,7 @@ def run(self):
         else:
             classnamedict[clsname] += 1
 
-        display_source = "display_source" in self.options
+        hide_source = "hide_source" in self.options
         save_as_gif = "save_as_gif" in self.options
         save_last_frame = "save_last_frame" in self.options
         assert not (save_as_gif and save_last_frame)
@@ -211,7 +211,7 @@ def run(self):
             raise ValueError("Invalid combination of render flags received.")
 
         rendered_template = jinja2.Template(TEMPLATE).render(
-            display_source=display_source,
+            hide_source=hide_source,
             filesrc_rel=os.path.relpath(filesrc, setup.confdir),
             output_file=output_file,
             save_last_frame=save_last_frame,
@@ -238,7 +238,7 @@ def setup(app):
 
 
 TEMPLATE = r"""
-{% if display_source %}
+{% if not hide_source %}
 .. raw:: html
 
     <div class="manim-example">
@@ -258,7 +258,7 @@ def setup(app):
     :align: center
 {% endif %}
 
-{% if display_source %}
+{% if not hide_source %}
 .. raw:: html
 
     </div>

docs/source/tutorials/a_deeper_look.rst

@@ -65,6 +65,7 @@ will play it once it's done since we are using the ``-p`` flag.  The output
 should look like this:
 
 .. manim:: SquareToCircle3
+   :hide_source:
    :quality: high
 
    class SquareToCircle3(Scene):

docs/source/tutorials/building_blocks.rst

@@ -61,7 +61,6 @@ screen, simply call the :meth:`~.Scene.remove` method from the containing
 :class:`.Scene`.
 
 .. manim:: CreatingMobjects
-   :display_source:
    :quality: medium
 
    class CreatingMobjects(Scene):
@@ -81,7 +80,6 @@ some mobjects to it.  This script generates a static picture that displays a
 circle, a square, and a triangle:
 
 .. manim:: Shapes
-   :display_source:
    :quality: medium
 
    class Shapes(Scene):
@@ -114,7 +112,6 @@ There are many other possible ways to place mobjects on the screen, for example
 ``MobjectPlacement`` uses all three.
 
 .. manim:: MobjectPlacement
-   :display_source:
    :quality: medium
 
    class MobjectPlacement(Scene):
@@ -163,7 +160,6 @@ Styling mobjects
 The following scene changes the default aesthetics of the mobjects.
 
 .. manim:: MobjectStyling
-   :display_source:
    :quality: medium
 
    class MobjectStyling(Scene):
@@ -200,7 +196,6 @@ The next scene is exactly the same as the ``MobjectStyling`` scene from the
 previous section, except for exactly one line.
 
 .. manim:: MobjectZOrder
-   :display_source:
    :quality: medium
 
    class MobjectZOrder(Scene):
@@ -234,7 +229,6 @@ At the heart of manim is animation.  Generally, you can add an animation to
 your scene by calling the :meth:`~.Scene.play` method.
 
 .. manim:: SomeAnimations
-   :display_source:
    :quality: medium
 
    class SomeAnimations(Scene):
@@ -271,7 +265,6 @@ method that changes a mobject's property can be used as an animation, through
 the use of :class:`.ApplyMethod`.
 
 .. manim:: ApplyMethodExample
-   :display_source:
    :quality: medium
 
    class ApplyMethodExample(Scene):
@@ -300,7 +293,6 @@ By default, any animation passed to :meth:`play` lasts for exactly one second.
 Use the :code:`run_time` argument to control the duration.
 
 .. manim:: RunTime
-   :display_source:
    :quality: medium
 
    class RunTime(Scene):

docs/source/tutorials/quickstart.rst

@@ -58,6 +58,7 @@ and open that file with the default movie player application.  You should see a
 video playing the following animation.
 
 .. manim:: SquareToCircle
+   :hide_source:
    :quality: low
 
    class SquareToCircle(Scene):
@@ -153,6 +154,7 @@ And render it using the following command:
 The output should look as follows.
 
 .. manim:: SquareToCircle2
+   :hide_source:
    :quality: low
 
    class SquareToCircle2(Scene):

manim/mobject/changing.py

@@ -16,7 +16,6 @@ class AnimatedBoundary(VGroup):
     Examples
     --------
     .. manim:: AnimatedBoundaryExample
-        :display_source:
         :quality: low
 
         class AnimatedBoundaryExample(Scene):
@@ -90,7 +89,6 @@ class TracedPath(VMobject):
     Examples
     --------
     .. manim:: TracedPathExample
-        :display_source:
         :quality: low
 
         class TracedPathExample(Scene):

manim/mobject/geometry.py

@@ -895,7 +895,7 @@ class ArrowTip(VMobject):
     a custom one like this:
 
     .. manim:: CustomTipExample
-        :display_source:
+        :quality: low
 
         >>> class MyCustomArrowTip(ArrowTip, RegularPolygon):
         ...     def __init__(self, **kwargs):

manim/mobject/value_tracker.py

@@ -21,7 +21,6 @@ class ValueTracker(Mobject):
     Examples
     --------
     .. manim:: ValueTrackerExample
-        :display_source:
         :quality: low
 
         class ValueTrackerExample(Scene):