Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly
Appearance settings

Commit 8e30d23

Browse filesBrowse files
kushalkolarkushalkolar
committed
Merge branch 'ndwidget' of https://github.com/fastplotlib/fastplotlib into ndwidget
2 parents c2dff86 + db49219 commit 8e30d23
Copy full SHA for 8e30d23

3 files changed

+37-32Lines changed: 37 additions & 32 deletions

File tree

Expand file treeCollapse file tree
Open diff view settings
Filter options
Expand file treeCollapse file tree
Open diff view settings
Collapse file

‎README.md‎

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 numberDiff line numberDiff line change
@@ -63,31 +63,28 @@ Questions, issues, ideas? You are welcome to post an [issue](https://github.com/
6363

6464
To install use pip:
6565

66-
```bash
67-
# with imgui and jupyterlab
68-
pip install -U "fastplotlib[notebook,imgui]"
66+
### With imgui support (recommended)
6967

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.
7269

73-
# with imgui
74-
pip install -U "fastplotlib[imgui]"
70+
pip install -U "fastplotlib[imgui]"
7571

76-
# to use in jupyterlab without imgui
77-
pip install -U "fastplotlib[notebook]"
78-
```
72+
With jupyterlab support.
7973

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]"
8175

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
8577

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.
8787

88-
```bash
89-
pip install simplejpeg
90-
```
9188

9289
> **Note:**
9390
> `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
Collapse file

‎docs/source/user_guide/guide.rst‎

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 numberDiff line numberDiff line change
@@ -6,31 +6,38 @@ Installation
66

77
To install use pip:
88

9-
.. code-block::
9+
With imgui support (recommended)
10+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1011

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.
1313

14-
# minimal install, install glfw, pyqt6 or pyside6 separately
15-
pip install -U fastplotlib
14+
.. code-block::
1615
17-
# with imgui
1816
pip install -U "fastplotlib[imgui]"
1917
20-
# to use in jupyterlab, no imgui
21-
pip install -U "fastplotlib[notebook]"
18+
With jupyterlab support.
2219

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]"
2423
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+
^^^^^^^^^^^^^
2826

29-
Once you have ``libjpeg-turbo``:
27+
Minimal, install desired GUI library such as PyQt6, PySide6, or glfw separately.
3028

3129
.. code-block::
3230
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.
40+
3441

3542
What is ``fastplotlib``?
3643
------------------------
Collapse file

‎pyproject.toml‎

Copy file name to clipboardExpand all lines: pyproject.toml
+1Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,7 @@ notebook = [
4646
"jupyter-rfb>=0.5.1",
4747
"ipywidgets>=8.0.0,<9",
4848
"sidecar",
49+
"simplejpeg",
4950
]
5051
tests = [
5152
"pytest",

0 commit comments

Comments
0 (0)
Morty Proxy This is a proxified and sanitized view of the page, visit original site.