Merge remote-tracking branch 'upstream/master' into newExamples

MysaaJava · MysaaJava · commit 71050b7e082d · 2020-10-21T13:54:42.000+02:00
diff --git a/.github/manimdependency.json b/.github/manimdependency.json
@@ -1,6 +1,25 @@
 {
-    "windows": {
-        "ffmpeg": "https://www.gyan.dev/ffmpeg/builds/packages/ffmpeg-4.3.1-2020-09-21-full_build.zip",
-        "pango": "v0.1.0"
-    }
+	"windows": {
+		"ffmpeg": "https://www.gyan.dev/ffmpeg/builds/packages/ffmpeg-4.3.1-2020-09-21-full_build.zip",
+		"pango": "v0.1.0",
+		"tinytex": [
+			"standalone",
+			"preview",
+			"doublestroke",
+			"ms",
+			"setspace",
+			"rsfs",
+			"relsize",
+			"ragged2e",
+			"fundus-calligra",
+			"microtype",
+			"wasysym",
+			"physics",
+			"dvisvgm",
+			"jknapltx",
+			"wasy",
+			"cm-super",
+			"babel-english"
+		]
+	}
 }
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -1,22 +1,22 @@
 name: CI
 on:
   push:
-      branches:
-        - master
+    branches:
+      - master
   pull_request:
-      branches:
-        - master
+    branches:
+      - master
 
 jobs:
   test:
     runs-on: ${{ matrix.os }}
     env:
-       POETRY_VIRTUALENVS_CREATE: false
+      POETRY_VIRTUALENVS_CREATE: false
     strategy:
       fail-fast: false
       matrix:
         os: [ubuntu-latest, macos-latest, windows-latest]
-        python: [3.6,3.7, 3.8]
+        python: [3.6, 3.7, 3.8]
 
     steps:
       - name: Checkout the repository
@@ -36,8 +36,8 @@ jobs:
         shell: bash
         id: pip-cache-and-time
         run: |
-           echo "::set-output name=dir::$(pip cache dir)"
-           echo "::set-output name=date::$(/bin/date -u "+%m%Y")"
+          echo "::set-output name=dir::$(pip cache dir)"
+          echo "::set-output name=date::$(/bin/date -u "+%m%Y")"
 
       - name: pip cache
         uses: actions/cache@v2
@@ -73,27 +73,31 @@ jobs:
         if: runner.os == 'Windows'
         uses: actions/cache@v2
         with:
-         path: ${{ github.workspace }}\ManimCache
-         key: ${{ runner.os }}-dependencies-ffmpeg-tinytex-${{ hashFiles('.github/manimdependency.json') }}-${{ steps.pip-cache-and-time.outputs.date }}
+          path: ${{ github.workspace }}\ManimCache
+          key: ${{ runner.os }}-dependencies-ffmpeg-tinytex-${{ hashFiles('.github/manimdependency.json') }}-${{ steps.pip-cache-and-time.outputs.date }}
 
       - name: Download system dependencies (Windows)
         if: runner.os == 'Windows' && steps.cache-windows.outputs.cache-hit != 'true'
         run: |
           $ffmpegUrl = python -c "import json;print(json.load(open('.github/manimdependency.json'))['windows']['ffmpeg'])"
           $pangoVersion = python -c "import json;print(json.load(open('.github/manimdependency.json'))['windows']['pango'])"
+          $tinyTexPackages = $(python -c "import json;print(' '.join(json.load(open('.github/manimdependency.json'))['windows']['tinytex']))") -Split ' '
           $OriPath = $env:PATH
           echo "Install Tinytex"
           Invoke-WebRequest "https://ci.appveyor.com/api/projects/yihui/tinytex/artifacts/TinyTeX.zip?job=image:%20Visual%20Studio%202019" -O "$($env:TMP)\TinyTex.zip"
           Expand-Archive -LiteralPath "$($env:TMP)\TinyTex.zip" -DestinationPath "$($PWD)\ManimCache\LatexWindows"
           $env:Path = "$($PWD)\ManimCache\LatexWindows\TinyTeX\bin\win32;$($env:PATH)"
           tlmgr update --self
-          tlmgr install standalone preview doublestroke ms setspace rsfs relsize ragged2e fundus-calligra microtype wasysym physics dvisvgm jknapltx wasy cm-super babel-english
+          foreach ($c in $tinyTexPackages){
+            $c=$c.Trim()
+            tlmgr install $c
+          }
           $env:PATH=$OriPath
           echo "Completed Latex"
           Invoke-WebRequest "$ffmpegUrl" -O "$($env:TMP)\ffmpeg.zip"
           7z x "$($env:TMP)\ffmpeg.zip" -o"$($PWD)\ManimCache"
           Move-Item "ManimCache\ffmpeg-*" "ManimCache\FFmpeg"
-          Invoke-WebRequest "https://github.com/ManimCommunity/manim-windows/releases/download/$($pangoVersion)/pango-windows-binaires-x64.zip" -O "$($env:TMP)\Pango.zip"
+          Invoke-WebRequest "https://github.com/ManimCommunity/pango-windows-binaries/releases/download/$($pangoVersion)/pango-windows-binaires-x64.zip" -O "$($env:TMP)\Pango.zip"
           mkdir "$($PWD)\ManimCache\Pango"
           7z x "$($env:TMP)\Pango.zip" -o"$($PWD)\ManimCache\Pango"
 
diff --git a/docs/source/examples.rst b/docs/source/examples.rst
@@ -6,7 +6,6 @@ Examples
    examples/shapes_images_positions
    examples/annotations
    examples/plots
-   examples/text
    examples/tex
    examples/formulas
    examples/3d
diff --git a/docs/source/examples/tex.rst b/docs/source/examples/tex.rst
@@ -1,5 +1,54 @@
+Text and LaTeX
+===============
+
+
+Text
+--------------
+The simplest way to add text to you animation is to use the :class:`~.Text` class. It uses the Cairo library to render text.
+A newer addition to manim is the :class:`~.PangoText` class, which uses the Pango library.
+
+The Text() mobject
++++++++++++++++++++
+
+.. manim:: Example1Text
+    :save_last_frame:
+
+    class Example1Text(Scene):
+        def construct(self):
+            text = Text('Hello world').scale(3)
+            self.add(text)
+
+For more examples, see: :class:`~.Text`.
+
+The PangoText() mobject
++++++++++++++++++++++++
+
+The :class:`~.PangoText` mobject uses the Pango library to render text. Use this whenever you want to use non-English alphabets like `你好` or  `こんにちは` or `안녕하세요` or `مرحبا بالعالم`.
+
+
 LaTeX
-=================================
+-------------------
+
+The Tex() mobject
++++++++++++++++++++
+Just as you can use :class:`~.Text` to add text to your videos, you can use :class:`~.Tex` to insert LaTeX.
+
+.. manim:: ExampleLaTeX
+    :save_last_frame:
+
+    class ExampleLaTeX(Scene):
+        def construct(self):
+            tex = Tex(r'\LaTeX').scale(3)
+            self.add(tex)
+
+Note that we are using a raw string (``r'---'``) instead of a regular string (``'---'``).
+This is because TeX code uses a lot of special characters - like ``\`` for example - 
+that have special meaning within a regular python string. An alternative would have
+been to write ``\\`` as in ``Tex('\\LaTeX')``.
+
+The MathTex() mobject
+++++++++++++++++++++++
+Anything enclosed in ``$`` signs is interpreted as maths-mode:
 
 .. manim:: Example1LaTeX
     :save_last_frame:
@@ -9,14 +58,45 @@ LaTeX
             tex = Tex(r'$\xrightarrow{Hello}$ \LaTeX').scale(3)
             self.add(tex)
 
+Whereas in a :class:`~.MathTex` mobject everything is math-mode by default and you would use ``\text{}`` to
+insert regular text:
+
+.. manim:: Example1bLaTeX
+    :save_last_frame:
+
+    class Example1bLaTeX(Scene):
+        def construct(self):
+            tex = MathTex(r'\xrightarrow{Hello}\text{ \LaTeX}').scale(3)
+            self.add(tex)
+
+LaTeX commands and keyword arguments
++++++++++++++++++++++++++++++++++++++
+We can use any standard LaTeX commands in the AMS maths packages. For example the ``mathtt`` text type.
+
 .. manim:: Example2LaTeX
     :save_last_frame:
 
     class Example2LaTeX(Scene):
         def construct(self):
-            tex = Tex(r'$\mathtt{Hello}$ \LaTeX', color=BLUE).scale(3)
+            tex = Tex(r'$\mathtt{Hello}$ \LaTeX').scale(3)
+            self.add(tex)
+
+On the manim side, the :class:`~.Tex` class also accepts attributes to change the appearance of the output. 
+This is very similar to the :class:`~.Text` class. For example, the ``color`` keyword changes the color of the TeX mobject:
+
+.. manim:: Example2bLaTeX
+    :save_last_frame:
+
+    class Example2bLaTeX(Scene):
+        def construct(self):
+            tex = Tex(r'Hello \LaTeX', color=BLUE).scale(3)
             self.add(tex)
 
+Extra LaTeX Packages
++++++++++++++++++++++
+Some commands require special packages to be loaded into the TeX template. For example, 
+to use the ``mathscr`` script, we need to add the ``mathrsfs`` package. Since this package isn't loaded
+into manim's tex template by default, we add it manually:
 
 .. manim:: Example3LaTeX
     :save_last_frame:
@@ -25,50 +105,62 @@ LaTeX
         def construct(self):
             myTemplate = TexTemplate()
             myTemplate.add_to_preamble(r"\usepackage{mathrsfs}")
-            tex = Tex(r'$\mathscr{H}ello$ \LaTeX}', tex_template=myTemplate).scale(3)
+            tex = Tex(r'$\mathscr{H} \rightarrow \mathbb{H}$}', tex_template=myTemplate).scale(3)
             self.add(tex)
 
+Substrings and parts
++++++++++++++++++++++
+The TeX mobject can accept multiple strings as arguments. Afterwards you can refer to the individual
+parts either by their index (like ``tex[1]``), or you can look them up by (parts of) the tex code like
+in this example where we set the color of the ``\bigstar`` using :func:`~.set_color_by_tex`:
 
 .. manim:: Example4LaTeX
     :save_last_frame:
 
     class Example4LaTeX(Scene):
         def construct(self):
-            tex = Tex('Hello', '$\\bigstar$', '\LaTeX').scale(3)
+            tex = Tex('Hello', r'$\bigstar$', r'\LaTeX').scale(3)
             tex.set_color_by_tex('igsta', RED)
             self.add(tex)
 
+LaTeX Maths Fonts - The Template Library
+++++++++++++++++++++++++++++++++++++++++++++
+Changing fonts in LaTeX when typesetting mathematical formulae is a little bit more tricky than 
+with regular text. It requires changing the template that is used to compile the tex code.
+Manim comes with a collection of :class:`~.TexFontTemplates` ready for you to use. These templates will all work
+in maths mode:
+
 .. manim:: Example5LaTeX
     :save_last_frame:
 
     class Example5LaTeX(Scene):
         def construct(self):
-            tex = Tex('Hello \LaTeX', tex_template=TexFontTemplates.french_cursive).scale(3)
+            tex = Tex(r'$f: A \rightarrow B$', tex_template=TexFontTemplates.french_cursive).scale(3)
             self.add(tex)
 
-.. manim:: Example5bLaTeX
-    :save_last_frame:
-
-    class Example5bLaTeX(Scene):
-        def construct(self):
-            templateForFrenchCursive = TexTemplate(
-                preamble=r"""
-    \usepackage[english]{babel}
-    \usepackage{amsmath}
-    \usepackage{amssymb}
-    \usepackage[T1]{fontenc}
-    \usepackage[default]{frcursive}
-    \usepackage[eulergreek,noplusnominus,noequal,nohbar,nolessnomore,noasterisk]{mathastext}
-    """)
-            tex = Tex('Hello \LaTeX', tex_template=templateForFrenchCursive).scale(3)
-            self.add(tex)
+Manim also has a :class:`~.TexTemplateLibrary` containing the TeX templates used by 3Blue1Brown. One example 
+is the ctex template, used for typesetting Chinese. For this to work, the ctex LaTeX package
+must be installed on your system. Furthermore, if you are only typesetting Text, you probably do not
+need :class:`~.Tex` at all, and should use :class:`~.Text` or :class:`~.PangoText` instead. 
 
 .. manim:: Example6LaTeX
     :save_last_frame:
 
     class Example6LaTeX(Scene):
         def construct(self):
-            tex = Tex('Hello 你好 \LaTeX', tex_template=TexTemplateLibrary.ctex).scale(3)
+            tex = Tex('Hello 你好 \\LaTeX', tex_template=TexTemplateLibrary.ctex).scale(3)
             self.add(tex)
 
 
+Aligning formulae
+++++++++++++++++++
+A :class:`~.MathTex` mobject is typeset in the LaTeX  ``align*`` environment. This means you can use the ``&`` alignment
+character when typesetting multiline formulae:
+
+.. manim:: Example7LaTeX
+    :save_last_frame:
+
+    class Example7LaTeX(Scene):
+        def construct(self):
+            tex = MathTex(r'f(x) &= 3 + 2 + 1\\ &= 5 + 1 \\ &= 6').scale(2)
+            self.add(tex)
diff --git a/docs/source/examples/text.rst b/docs/source/examples/text.rst
diff --git a/docs/source/manim_directive.py b/docs/source/manim_directive.py
@@ -173,15 +173,15 @@ def run(self):
             f'config["frame_rate"] = {frame_rate}',
             f'config["pixel_height"] = {pixel_height}',
             f'config["pixel_width"] = {pixel_width}',
-            f'file_writer_config["media_dir"] = "{media_dir}"',
-            f'file_writer_config["images_dir"] = "{images_dir}"',
-            f'file_writer_config["tex_dir"] = "{tex_dir}"',
-            f'file_writer_config["text_dir"] = "{text_dir}"',
-            f'file_writer_config["video_dir"] = "{video_dir}"',
+            f'file_writer_config["media_dir"] = r"{media_dir}"',
+            f'file_writer_config["images_dir"] = r"{images_dir}"',
+            f'file_writer_config["tex_dir"] = r"{tex_dir}"',
+            f'file_writer_config["text_dir"] = r"{text_dir}"',
+            f'file_writer_config["video_dir"] = r"{video_dir}"',
             f'file_writer_config["save_last_frame"] = {save_last_frame}',
             f'file_writer_config["write_to_movie"] = {write_to_movie}',
             f'file_writer_config["save_as_gif"] = {save_as_gif}',
-            f'file_writer_config["output_file"] = "{output_file}"',
+            f'file_writer_config["output_file"] = r"{output_file}"',
         ]
 
         user_code = self.content
