Skip to content

Update installation docs #1013

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
kushalkolar merged 4 commits into from
Mar 17, 2026
Merged

Update installation docs #1013

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
41985b2
add simplejpeg to notebook deps
kushalkolar Mar 17, 2026
19de189
Update guide.rst
kushalkolar Mar 17, 2026
047f136
Update guide.rst
kushalkolar Mar 17, 2026
ab577c2
Update README.md
kushalkolar Mar 17, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 15 additions & 18 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,31 +63,28 @@ Questions, issues, ideas? You are welcome to post an [issue](https://github.com/

To install use pip:

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

# minimal install, install glfw, pyqt6 or pyside6 separately
pip install -U fastplotlib
Without jupyterlab support, install desired GUI framework such as glfw, PyQt6, or PySide6 separately.

# with imgui
pip install -U "fastplotlib[imgui]"
pip install -U "fastplotlib[imgui]"

# to use in jupyterlab without imgui
pip install -U "fastplotlib[notebook]"
```
With jupyterlab support.

We strongly recommend installing ``simplejpeg`` for use in notebooks, you must first install [libjpeg-turbo](https://libjpeg-turbo.org/)
pip install -U "fastplotlib[notebook,imgui]"

- If you use ``conda``, you can get ``libjpeg-turbo`` through conda.
- If you are on linux, you can get it through your distro's package manager.
- For Windows and Mac compiled binaries are available on their release page: https://github.com/libjpeg-turbo/libjpeg-turbo/releases
### Without imgui

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

pip install fastplotlib

With jupyterlab support only.

pip install -U "fastplotlib[notebook]"

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.

```bash
pip install simplejpeg
```

> **Note:**
> `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
Expand Down
35 changes: 21 additions & 14 deletions docs/source/user_guide/guide.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,31 +6,38 @@ Installation

To install use pip:

.. code-block::
With imgui support (recommended)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

# with imgui and jupyterlab
pip install -U "fastplotlib[notebook,imgui]"
Without jupyterlab support, install desired GUI framework such as glfw, PyQt6, or PySide6 separately.

# minimal install, install glfw, pyqt6 or pyside6 separately
pip install -U fastplotlib
.. code-block::

# with imgui
pip install -U "fastplotlib[imgui]"

# to use in jupyterlab, no imgui
pip install -U "fastplotlib[notebook]"
With jupyterlab support.

We strongly recommend installing ``simplejpeg`` for use in notebooks, you must first install `libjpeg-turbo <https://libjpeg-turbo.org/>`_.
.. code-block::

pip install -U "fastplotlib[notebook,imgui]"

- If you use ``conda``, you can get ``libjpeg-turbo`` through conda.
- If you are on linux you can get it through your distro's package manager.
- For Windows and Mac compiled binaries are available on their release page: https://github.com/libjpeg-turbo/libjpeg-turbo/releases
Without imgui
^^^^^^^^^^^^^

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

.. code-block::

pip install simplejpeg
pip install fastplotlib

With jupyterlab support only.

.. code-block::

pip install -U "fastplotlib[notebook]"

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.


What is ``fastplotlib``?
------------------------
Expand Down
1 change: 1 addition & 0 deletions pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,7 @@ notebook = [
"jupyter-rfb>=0.5.1",
"ipywidgets>=8.0.0,<9",
"sidecar",
"simplejpeg",
]
tests = [
"pytest",
Expand Down