From 76689aa66e28abc8f692e8563b507f56ad751722 Mon Sep 17 00:00:00 2001 From: "Sebastian M. Ernst" Date: Sun, 7 Nov 2021 12:17:53 +0100 Subject: [PATCH] prefer conda --- README.md | 20 ++++++++++---------- docs/installation.rst | 30 +++++++++++++++--------------- 2 files changed, 25 insertions(+), 25 deletions(-) diff --git a/README.md b/README.md index 20d8717..8afcdb1 100644 --- a/README.md +++ b/README.md @@ -21,6 +21,16 @@ `bewegung` can be installed both via ``conda`` and via ``pip``. +### Via `conda` + +An almost complete installation can be triggered by running: + +```bash +conda install -c conda-forge bewegung +``` + +Please note that [mplcairo](https://github.com/matplotlib/mplcairo), a dependency of `bewegung` and alternative backend for `matplotlib`, is currently not available via `conda` and must be installed manually. `bewegung` [does also work without `mplcairo` present](https://bewegung.readthedocs.io/en/latest/canvas.html#acceleratingmatplotlib) and falls back to the `cairo` backend of `matplotlib`. + ### Via `pip` A bare **minimum** of `bewegung` can be installed with Python's package manager `pip`: @@ -37,16 +47,6 @@ pip install -vU bewegung[all] Certain non-Python **prerequisites** must installed separately and before invoking the above command. [For detailed instructions, see documentation](https://bewegung.readthedocs.io/en/latest/installation.html). Most notably, `ffmpeg` should be installed for producing actual video files instead of video frames as individual files. See [download section](https://ffmpeg.org/download.html) of the `ffmpeg` project website for further instructions. -### Via `conda` - -An almost complete installation can be triggered by running: - -```bash -conda install -c conda-forge bewegung -``` - -Please note that [mplcairo](https://github.com/matplotlib/mplcairo), a dependency of `bewegung` and alternative backend for `matplotlib`, is currently not available via `conda` and must be installed manually. `bewegung` [does also work without `mplcairo` present](https://bewegung.readthedocs.io/en/latest/canvas.html#acceleratingmatplotlib) and falls back to the `cairo` backend of `matplotlib`. - ## Example See [`demo.py`](https://github.com/pleiszenburg/bewegung/blob/master/demo/demo.py). diff --git a/docs/installation.rst b/docs/installation.rst index e3aa1fb..a5dad87 100644 --- a/docs/installation.rst +++ b/docs/installation.rst @@ -17,6 +17,21 @@ Quick Install Guide `bewegung` can be installed both via ``conda`` and via ``pip``. +Via ``conda`` +~~~~~~~~~~~~~ + +An almost complete installation can be triggered by running: + +.. code:: bash + + conda install -c conda-forge bewegung + +.. note:: + + `mplcairo`_, a dependency of ``bewegung`` and alternative backend for ``matplotlib``, is currently not available via ``conda`` and must be installed manually. ``bewegung`` :ref:`does also work without mplcairo present ` and falls back to the ``cairo`` backend of ``matplotlib``. + +.. _mplcairo: https://github.com/matplotlib/mplcairo + Via ``pip`` ~~~~~~~~~~~ @@ -59,21 +74,6 @@ The actual installation of ``bewegung`` can now be triggered as follows: pip install -vU bewegung[all] # install bewegung -Via ``conda`` -~~~~~~~~~~~~~ - -An almost complete installation can be triggered by running: - -.. code:: bash - - conda install -c conda-forge bewegung - -.. note:: - - `mplcairo`_, a dependency of ``bewegung`` and alternative backend for ``matplotlib``, is currently not available via ``conda`` and must be installed manually. ``bewegung`` :ref:`does also work without mplcairo present ` and falls back to the ``cairo`` backend of ``matplotlib``. - -.. _mplcairo: https://github.com/matplotlib/mplcairo - Validate Installation ~~~~~~~~~~~~~~~~~~~~~