Skip to main content

A tool for live plotting and processing data

Project description

plottr: modular data plotting and processing

PyPi version PyPI python versions Docs Build on GitHub actions

A framework for inspecting data, based on flowcharts from pyqtgraph. plottr's main aim is to allow the user to define custom data processing flows and plotting. A particular use case is data filtering and plotting.

Documentation:

https://plottr.readthedocs.io (work in progress...)

Quickstart

Installation

Plottr is installable from pypi with pip install plottr

To install with either PyQt5 or Pyside2 backend you can do pip install plottr[PyQt5] or pip install plottr[Pyside2] Note that if you have installed pyqt from (Ana)Conda you should not use any of these targets but do pip install plottr

To install from source: clone the repo, and install using pip install -e .

inspectr: QCoDeS dataset inspection and (live) plotting

You can use the inspectr tool to get a simple overview over QCoDeS database files, and plot datasets contained in the database.

To use: run plottr-inspectr [--dbpath <path to your .db file>]

As an alternative from the root of the cloned plottr repository, run python apps/inspectr.py [--dbpath <path to your .db file>]

For basic instructions, check out the Notebook Live plotting qcodes data under /doc/examples.

Some notes on installing

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.7 (f-strings...)
  • the usual: numpy, mpl, ...
  • pandas >= 0.22
  • xarray
  • pyqtgraph >= 0.10.0

Recent changes:

2021-02-16

Added

  • Add copy content features to inspectr and autoplot windows, specifically
    • a new Copy pop up menu for copying content of cells in inspectr
    • a new Copy metadata button in plot window for copying info about the dataset to clipboard

Fixed

  • remove redundant information between the optional "info" box on the plot and the plot title

2021-02-08

  • Drop support for Python 3.6 and support type-checking with qcodes 0.21.0
  • Fix type-checking with numpy 1.20

Fixed

  • Fixed y-axis to not show axis-label if more than one plot is selected in 1D single-plot show.

2020-08-21

  • Workaround for bug with pyqt installed via conda that would result in blank icons.
  • Add experimental support for using Pyside2 as an alternative to PyQt5

2020-08-06

Added

  • Entry points for inspectr (plottr-inspectr) and autoplot (plottr-autoplot-ddh5)
  • LICENSE file has been added (no change to license of the code)
  • setup.py has been tweeked to ensure that sdist and bdist_wheel packages are generated correctly

2020-06-05

Added

  • Usable version of hdf5 file support. can use the apps/monitr.py script to launch a tool that allows easy (live) plotting.

2020-04-24

Fixed

  • there were several issues/annoyances that caused (minor) issues with grid handling and plotting in rare-ish circumstances. Most of them should be fixed now.

Added

  • A few docs and examples, mostly about grid usage.

2020-04-17

Changed

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page