manim/docs/source/installation/linux.rst
Nikhil Garuda 7c8c1cb1d9
Grammatical error corrections in documentation (#1360)
* Grammatical error correction of docs

* Update contributing.rst

* Update development.rst

* Update development.rst

* Update development.rst

* Update for_dev.rst

* Update docs/source/installation/for_dev.rst

Co-authored-by: Darylgolden <darylgolden@gmail.com>

* Update plugins.rst

* Update reporting_bugs.rst

* Update a_deeper_look.rst

* Update configuration.rst

* Update quickstart.rst

* Update building_blocks.rst

* Update testing.rst

* Update testing.rst

* Update versions.rst

* Update a_deeper_look.rst

* Update quickstart.rst

* Update quickstart.rst

* Update development.rst

* Update development.rst

* Update versions.rst

* Update versions.rst

* Update a_deeper_look.rst

* Update building_blocks.rst

* Change of complier and output format in
 "InCodeTexTemplate" to the defaults

* Reverted back

* Change of Complier and Output format

The Complier and Output format of class InCodeTexTemplate has been changed to the defaults (latex and .dvi)

* Update customtex.py

* Update building_blocks.rst

* Update building_blocks.rst

* Update a_deeper_look.rst

Co-authored-by: Darylgolden <darylgolden@gmail.com>
Co-authored-by: kilacoda <65204531+kilacoda@users.noreply.github.com>
Co-authored-by: Jason Villanueva <a@jsonvillanueva.com>
2021-04-19 15:44:32 -07:00

174 lines
4.1 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.
Ubuntu/Mint/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 Pango:
.. code-block:: bash
sudo apt install libpango1.0-dev
To install ffmpeg:
.. code-block:: bash
sudo apt install ffmpeg
To install LaTeX:
(For minimal LaTeX installation, see `TinyTex Installation`_)
.. code-block:: bash
sudo apt install texlive texlive-latex-extra texlive-fonts-extra \
texlive-latex-recommended texlive-science texlive-fonts-extra tipa
If you don't have python3-pip installed, install it:
.. code-block:: bash
sudo apt install python3-pip
.. note:: These instructions are also valid for other Debian-based
distributions or distributions that use the ``apt`` package manager.
Fedora/CentOS/RHEL
******************
To install cairo:
.. code-block:: bash
sudo dnf install cairo-devel
To install Pango:
.. code-block:: bash
sudo dnf install pango-devel
To install ffmpeg, you have to add RPMfusion repository (If it's not already added). Please follow the instructions for your specific distribution in the following URL:
https://rpmfusion.org/Configuration/
Install ffmpeg from RPMfusion repository:
.. code-block:: bash
sudo dnf install ffmpeg
Install python development headers in order to successfully build pycairo wheel:
.. code-block:: bash
sudo dnf install python3-devel
To install LaTeX:
(For minimal LaTeX installation, see `TinyTex Installation`_)
.. code-block:: bash
sudo dnf install texlive-scheme-medium
Arch/Manjaro
************
Before installing anything, make sure that your system is up to date.
.. code-block:: bash
sudo pacman -Syu
To install cairo:
.. code-block:: bash
sudo pacman -S cairo
To install pango:
.. code-block:: bash
sudo pacman -S pango
To install ffmpeg:
.. code-block:: bash
sudo pacman -S ffmpeg
To install LaTeX:
(For minimal LaTeX installation, see `TinyTex Installation`_)
.. code-block:: bash
sudo pacman -S texlive-most
If you don't have python-pip installed, install it:
.. code-block:: bash
sudo pacman -S python-pip
.. note:: These instructions are also valid for other Arch-based
distributions or distributions that use the ``pacman`` package
manager.
TinyTex Installation
********************
If you do not want to install full LaTeX (~2GB), you can install TinyTex (~500MB)
and some extra packages for a minimal LaTeX installation. This is what done for
choco ``manim-latex`` package for Windows.
Install `TinyTex`_ and make sure to add ``bin`` folder created in your home
directory to your ``PATH``.
For extra packages, see "Files > tools\chocolateyinstall.ps1" `here`_ and
find ``tlmgr install ...`` command. Run that in terminal and
finally ``tlmgr path add`` to add all the symlinks correctly.
.. _TinyTex: https://yihui.org/tinytex/#for-other-users
.. _here: https://community.chocolatey.org/packages/manim-latex#files
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.)
.. 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`.