File: installation.md

package info (click to toggle)
magicgui 0.9.1-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 21,796 kB
  • sloc: python: 11,202; makefile: 11; sh: 9
file content (52 lines) | stat: -rw-r--r-- 1,203 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
# Installation

**magicgui** is a pure Python package, and can be installed with `pip`:

```bash
pip install magicgui
```

or with `conda`:

```bash
conda install -c conda-forge magicgui
```

## Backends

**magicgui** requires a backend to be installed in order to function, but it
does not specify a particular backend by default.  The following backends are
available:

- `PyQt5`:  `pip install magicgui[pyqt5]`
- `PyQt6`:  `pip install magicgui[pyqt6]`
- `PySide2`:  `pip install magicgui[pyside2]`
- `PySide6`:  `pip install magicgui[pyside6]`
- `Jupyter Widgets`:  `pip install magicgui[jupyter]`

!!!important

    Note not all widgets are necessarily implemented for all backends.
    Most widgets in the [widget docs](../api/widgets/) specify which backends
    are supported.

## Extras

The [`Image`][magicgui.widgets.Image] widget requires `pillow`. You may use the `image` extra:

```bash
pip install magicgui[image]
```

The `magicgui.tqdm` module requires `tqdm`. You may use the `tqdm` extra:

```bash
pip install magicgui[tqdm]
```

The [`QuantityEdit`][magicgui.widgets.QuantityEdit] widget requires `pint`.
You may use the `quantity` extra:

```bash
pip install magicgui[quantity]
```