You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+15-18Lines changed: 15 additions & 18 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -63,31 +63,28 @@ Questions, issues, ideas? You are welcome to post an [issue](https://github.com/
63
63
64
64
To install use pip:
65
65
66
-
```bash
67
-
# with imgui and jupyterlab
68
-
pip install -U "fastplotlib[notebook,imgui]"
66
+
### With imgui support (recommended)
69
67
70
-
# minimal install, install glfw, pyqt6 or pyside6 separately
71
-
pip install -U fastplotlib
68
+
Without jupyterlab support, install desired GUI framework such as glfw, PyQt6, or PySide6 separately.
72
69
73
-
# with imgui
74
-
pip install -U "fastplotlib[imgui]"
70
+
pip install -U "fastplotlib[imgui]"
75
71
76
-
# to use in jupyterlab without imgui
77
-
pip install -U "fastplotlib[notebook]"
78
-
```
72
+
With jupyterlab support.
79
73
80
-
We strongly recommend installing ``simplejpeg`` for use in notebooks, you must first install [libjpeg-turbo](https://libjpeg-turbo.org/)
74
+
pip install -U "fastplotlib[notebook,imgui]"
81
75
82
-
- If you use ``conda``, you can get ``libjpeg-turbo`` through conda.
83
-
- If you are on linux, you can get it through your distro's package manager.
84
-
- For Windows and Mac compiled binaries are available on their release page: https://github.com/libjpeg-turbo/libjpeg-turbo/releases
76
+
### Without imgui
85
77
86
-
Once you have ``libjpeg-turbo``:
78
+
Minimal, install desired GUI library such as PyQt6, PySide6, or glfw separately.
79
+
80
+
pip install fastplotlib
81
+
82
+
With jupyterlab support only.
83
+
84
+
pip install -U "fastplotlib[notebook]"
85
+
86
+
Fastplotlib is also available on conda-forge. For imgui support you will need to separately install `imgui-bundle`, and for jupyterlab you will need to install `jupyter-rfb` and `simplejpeg` which are all available on conda-forge.
87
87
88
-
```bash
89
-
pip install simplejpeg
90
-
```
91
88
92
89
> **Note:**
93
90
> `fastplotlib` and `pygfx` are fast evolving projects, the version available through pip might be outdated, you will need to follow the "For developers" instructions below if you want the latest features. You can find the release history here: https://github.com/fastplotlib/fastplotlib/releases
Copy file name to clipboardExpand all lines: docs/source/user_guide/guide.rst
+21-14Lines changed: 21 additions & 14 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,31 +6,38 @@ Installation
6
6
7
7
To install use pip:
8
8
9
-
.. code-block::
9
+
With imgui support (recommended)
10
+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
10
11
11
-
# with imgui and jupyterlab
12
-
pip install -U "fastplotlib[notebook,imgui]"
12
+
Without jupyterlab support, install desired GUI framework such as glfw, PyQt6, or PySide6 separately.
13
13
14
-
# minimal install, install glfw, pyqt6 or pyside6 separately
15
-
pip install -U fastplotlib
14
+
.. code-block::
16
15
17
-
# with imgui
18
16
pip install -U "fastplotlib[imgui]"
19
17
20
-
# to use in jupyterlab, no imgui
21
-
pip install -U "fastplotlib[notebook]"
18
+
With jupyterlab support.
22
19
23
-
We strongly recommend installing ``simplejpeg`` for use in notebooks, you must first install `libjpeg-turbo <https://libjpeg-turbo.org/>`_.
20
+
.. code-block::
21
+
22
+
pip install -U "fastplotlib[notebook,imgui]"
24
23
25
-
- If you use ``conda``, you can get ``libjpeg-turbo`` through conda.
26
-
- If you are on linux you can get it through your distro's package manager.
27
-
- For Windows and Mac compiled binaries are available on their release page: https://github.com/libjpeg-turbo/libjpeg-turbo/releases
24
+
Without imgui
25
+
^^^^^^^^^^^^^
28
26
29
-
Once you have ``libjpeg-turbo``:
27
+
Minimal, install desired GUI library such as PyQt6, PySide6, or glfw separately.
30
28
31
29
.. code-block::
32
30
33
-
pip install simplejpeg
31
+
pip install fastplotlib
32
+
33
+
With jupyterlab support only.
34
+
35
+
.. code-block::
36
+
37
+
pip install -U "fastplotlib[notebook]"
38
+
39
+
Fastplotlib is also available on conda-forge. For imgui support you will need to separately install ``imgui-bundle``, and for jupyterlab you will need to install ``jupyter-rfb`` and ``simplejpeg`` which are all available on conda-forge.
0 commit comments