manim/docs/source/installation/linux.rst
Aathish Sivasubrahmanian 6df53cc9f7
Deprecate TexMobject and TextMobject in favour of MathTex and Tex (#391)
* Rename TexMobject to MathTex
Rename TextMobject to Tex
Replace all instances of TexMobject with MathTex and TextMobject with Tex.
Get rid of single-use TexSymbol.
Rename SingleStringTexMobject to SingleStringMathTex.
Add Deprecation warnings to TexMobject and TextMobject.

* Edit __all__ for tex_mobject.py

* Re-add TexSymbol by request of devs.

* Docstring Modifications by @pgbiel

Co-authored-by: Pg Biel <9021226+PgBiel@users.noreply.github.com>

* Import logger differently, by @leotrs

* Run updated Black on files changed.

Co-authored-by: Pg Biel <9021226+PgBiel@users.noreply.github.com>
2020-09-02 09:20:37 +05:30

100 lines
2.4 KiB
ReStructuredText

Linux
=====
The following instructions are given for different linux distributions that use
different package managers. After executing the instructions corresponding to
your distribution, go to `Certifying a clean install`_ to check whether the
dependencies are installed correctly. All distributions will follow the same
instructions in `Certifying a clean install`_.
The two necessary dependencies are cairo and ffmpeg. LaTeX is strongly
recommended, as it is necessary to have access to the ``Tex`` and ``MathTex`` classes.
Sox is only required if you want manim to play sounds when rendering scenes.
Ubuntu/Debian
*************
Before installing anything, make sure that your system is up to date.
.. code-block:: bash
sudo apt update
sudo apt upgrade
To install cairo:
.. code-block:: bash
sudo apt install libcairo2-dev
To install ffmpeg:
.. code-block:: bash
sudo apt install ffmpeg
To install LaTeX:
.. code-block:: bash
sudo apt install texlive texlive-latex-extra texlive-fonts-extra \
texlive-latex-recommended texlive-science texlive-fonts-extra tipa
To install Sox (optional):
.. code-block:: bash
sudo apt install sox
.. note:: These instructions are also valid for other Debian-based
distributions or distributions that use the ``apt`` package manager.
Arch/Manjaro
************
To install cairo:
.. code-block:: bash
sudo pacman -S cairo
To install ffmpeg:
.. code-block:: bash
sudo pacman -S ffmpeg
To install LaTeX:
.. code-block:: bash
sudo pacman -S texlive-most
To install Sox (optional):
.. code-block:: bash
sudo pacman -S sox
.. note:: These instructions are also valid for other Arch-based
distributions or distributions that use the ``pacman`` package
manager.
Certifying a clean install
**************************
To check that all dependencies have been installed properly, you can execute
the commands ``ffmpeg -version`` and ``latex``. (If LaTeX is installed
properly, you will be taken to a command-line program that captures your
cursor. Press CTRL+C to exit.) To check that Sox is installed correctly,
simply run ``sox``.
.. note:: Note the LaTeX installation may take up a lot of space. The manim
community developers are currently working on providing a simpler,
lighter LaTeX package for you to install.
After making sure you have a clean install, you can go back to
:ref:`installing-manim`.