Skip to content

Commit

Permalink
prefer conda
Browse files Browse the repository at this point in the history
  • Loading branch information
s-m-e committed Nov 7, 2021
1 parent c7e4705 commit 76689aa
Show file tree
Hide file tree
Showing 2 changed files with 25 additions and 25 deletions.
20 changes: 10 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`:
Expand All @@ -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).
Expand Down
30 changes: 15 additions & 15 deletions docs/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 <acceleratingmatplotlib>` and falls back to the ``cairo`` backend of ``matplotlib``.

.. _mplcairo: https://github.com/matplotlib/mplcairo

Via ``pip``
~~~~~~~~~~~

Expand Down Expand Up @@ -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 <acceleratingmatplotlib>` and falls back to the ``cairo`` backend of ``matplotlib``.

.. _mplcairo: https://github.com/matplotlib/mplcairo

Validate Installation
~~~~~~~~~~~~~~~~~~~~~

Expand Down

0 comments on commit 76689aa

Please sign in to comment.