Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion .github/actions/install-dependencies-and-plottr/action.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,5 +8,5 @@ runs:
python -m pip install --upgrade pip setuptools wheel
pip install -r requirements.txt
pip install -r test_requirements.txt
pip install .[pyqt5]
pip install .[pyside6]
shell: bash
7 changes: 5 additions & 2 deletions .github/workflows/python-app.yml
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,12 @@ jobs:
DISPLAY: ':99.0'

steps:
- name: setup ubuntu-latest xvfb
# Source - https://stackoverflow.com/questions/75497408/github-action-pytest-exit-code-134
# Posted by Justin Buiel
# Retrieved 2026-01-03, License - CC BY-SA 4.0
- uses: tlambert03/setup-qt-libs@v1
- name: build "display"
run: |
sudo apt install libxkbcommon-x11-0 libxcb-icccm4 libxcb-image0 libxcb-keysyms1 libxcb-randr0 libxcb-render-util0 libxcb-xinerama0 libxcb-xfixes0 x11-utils
/sbin/start-stop-daemon --start --quiet --pidfile /tmp/custom_xvfb_99.pid --make-pidfile --background --exec /usr/bin/Xvfb -- :99 -screen 0 1920x1200x24 -ac +extension GLX
- uses: actions/checkout@v7
- name: Set up Python ${{ matrix.python-version }}
Expand Down
37 changes: 30 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,20 +18,42 @@ https://plottr.readthedocs.io (work in progress...)

Plottr is installable from pypi with `pip install plottr`

Plottr requires either the PyQt5 or Pyside2 gui framework.
To install with PyQt5 or Pyside2 backend you can do
``pip install plottr[PyQt5]`` or ``pip install plottr[Pyside2]``
### Qt bindings

Note that if you have installed ``pyqt`` from ``(Ana)Conda`` you should not use any of these
targets but do ``pip install plottr`` or install Plottr from conda forge:
Plottr is a Qt application. At runtime it talks to Qt through
[`qtpy`](https://github.com/spyder-ide/qtpy), so it works with any of the
supported Qt bindings, but **you must install one yourself** -- none is pulled
in automatically. Pick exactly one of:

| Binding | pip extra | Notes |
|-----------|----------------------------|------------------------------------|
| PySide6 | `pip install plottr[pyside6]` | **Recommended** (and what testing/type-checking use by default) |
| PyQt5 | `pip install plottr[pyqt5]` | |
| PyQt6 | `pip install plottr[pyqt6]` | |
| PySide2 | `pip install plottr[pyside2]` | Older Qt5 binding |

For example, the recommended install is:

```
pip install plottr[pyside6]
```

If you have **more than one** binding installed, select which one plottr (via
`qtpy`) should use by setting the `QT_API` environment variable before starting,
e.g. `QT_API=pyside6` (other valid values: `pyqt5`, `pyqt6`, `pyside2`).

If you installed `pyqt` from `(Ana)Conda` you should **not** use any of the pip
extras above; instead do `pip install plottr` (Qt comes from conda) or install
plottr from conda-forge:

```
conda config --add channels conda-forge
conda config --set channel_priority strict
conda install plottr
```

To install from source: clone the repo, and install using `pip install -e .`
To install from source: clone the repo, and install using
`pip install -e .[pyside6]` (or another binding extra of your choice).

## inspectr: QCoDeS dataset inspection and (live) plotting

Expand All @@ -50,11 +72,12 @@ Note: this package is not compatible with the original `plottr` tool.
You might want to install freshly if you still use the old version.

## Requirements:
* python >= 3.8
* python >= 3.12
* the usual: numpy, mpl, ...
* pandas >= 0.22
* xarray
* pyqtgraph >= 0.12.1
* one Qt binding (PySide6 recommended; see [Installation](#installation))

# Recent changes:

Expand Down
20 changes: 0 additions & 20 deletions doc/Makefile

This file was deleted.

5 changes: 0 additions & 5 deletions doc/api/data.rst

This file was deleted.

10 changes: 0 additions & 10 deletions doc/api/index.rst

This file was deleted.

7 changes: 0 additions & 7 deletions doc/api/node.rst

This file was deleted.

67 changes: 0 additions & 67 deletions doc/api/plot.rst

This file was deleted.

59 changes: 0 additions & 59 deletions doc/concepts/data.rst

This file was deleted.

13 changes: 0 additions & 13 deletions doc/concepts/index.rst

This file was deleted.

117 changes: 0 additions & 117 deletions doc/concepts/nodes.bak.rst

This file was deleted.

4 changes: 0 additions & 4 deletions doc/concepts/nodes.rst

This file was deleted.

Loading
Loading