Skip to content

Update installation instructions for MacOS (via dedicated brew formula) #3857

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jul 14, 2024
Merged

Update installation instructions for MacOS (via dedicated brew formula) #3857

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9673b88
Update macos.rst
Elastino Jul 14, 2024
f77e05b
Update docs/source/installation/macos.rst
behackl Jul 14, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 4 additions & 35 deletions docs/source/installation/macos.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,46 +17,15 @@ follow `Homebrew's installation instructions <https://docs.brew.sh/Installation>
(and is recommended to) be installed natively.


Required Dependencies
Installing Manim
---------------------

To install all required dependencies for installing Manim (namely: Python,
and some required Python packages), run:
As of July/2024, brew can install Manim including all required dependencies.
To install Manim:

.. code-block:: bash

brew install py3cairo

On *Apple Silicon* based machines (i.e., devices with the M1 chip or similar; if
you are unsure which processor you have check by opening the Apple menu, select
*About This Mac* and check the entry next to *Chip*), some additional dependencies
are required, namely:

.. code-block:: bash

brew install pango pkg-config scipy

After all required dependencies are installed, simply run:

.. code-block:: bash

pip3 install manim

to install Manim.

.. note::

A frequent source for installation problems is if ``pip3``
does not point to the correct Python installation on your system.
To check this, run ``pip3 -V``: for macOS Intel, the path should
start with ``/usr/local``, and for Apple Silicon with
``/opt/homebrew``. If this is not the case, you either forgot
to modify your shell profile (``.zprofile``) during the installation
of Homebrew, or did not reload your shell (e.g., by opening a new
terminal) after doing so. It is also possible that some other
software (like Pycharm) changed the ``PATH`` variable – to fix this,
make sure that the Homebrew-related lines in your ``.zprofile`` are
at the very end of the file.
brew install manim

.. _macos-optional-dependencies:

Expand Down