pydm 1.28.2

A Python-Qt based framework for building user interfaces for control systems

PyDM: Python Display Manager

PyDM is a Python-Qt based framework for building user interfaces for control systems. The goal is to provide a no-code, drag-and-drop system to make simple screens, as well as a straightforward Python framework to build complex applications.

« Explore PyDM docs and tutorials »

Report bug · Request feature · How to Contribute · Support

Python Qt Wrapper

PyDM project uses the qtpy as the abstraction layer for the Qt Python wrappers (PyQt5/PyQt4/PySide2/PySide6). All tests are performed with PyQt5.

Prerequisites

• Python >= 3.10, <= 3.12
• Qt 5.6 or higher
• qtpy
• PyQt5 >= 5.7 or PySide6 >= 6.9.2

Note: If you'd like to use Qt Designer (drag-and-drop tool to build interfaces) you'll need to make sure you have the PyQt5/PySide6 plugin for Designer installed. This usually happens automatically when you install PyQt5/PySide6 from source, but if you install it from a package manager, it may be left out.

Python package requirements are listed in the requirements.txt file, which can be used to install all requirements from pip: 'pip install -r requirements.txt'

Related Projects

PyDMConverter: A new tool for converting legacy control system displays (eg. EDM) into PyDM.

Related Projects: a list of some active projects built using PyDM.

Getting Started

For developers who wish to contribute to PyDM and modify the source code, please follow the "Getting Started!" instructions found here: https://github.com/slaclab/pydm/blob/master/CONTRIBUTING.rst#get-started.

For users who want to just install and run PyDM, follow the "Installation" instructions found in the docs: https://slaclab.github.io/pydm/installation.html

Running the Tests

In order to run the tests you will need to install some dependencies that are not part of the runtime dependencies of PyDM.

Assuming that you have cloned this repository do:

pip install -r dev-requirements.txt

python run_tests.py

If you want to see the coverage report do:

python run_tests.py --show-cov

Running the Examples

There are various examples of some of the features of the display manager. To launch a particular display run 'python scripts/pydm '.

There is a 'home' display in the examples directory with buttons to launch all the examples:

pydm examples/home.ui

Building the Documentation Locally

In order to build the documentation you will need to install some dependencies that are not part of the runtime dependencies of PyDM.

Assuming that you have cloned this repository do:

pip install -r docs-requirements.txt

cd docs
make html

This will generate the HTML documentation for PyDM at the <>/docs/build/html folder. Look for the index.html file and open it with your browser.

Online Documentation

Documentation is available at http://slaclab.github.io/pydm/. Documentation is somewhat sparse right now, unfortunately.

Widget Designer Plugins

PyDM widgets are written in Python, and are loaded into Qt Designer via the PyQt5/PySide6 Qt Designer Plugin.

For PyQt5, if you want to use the pydm widgets in Qt Designer, add the pydm directory (which holds register_pydm_designer_plugin.py) to your PYQTDESIGNERPATH environment variable. For PySide6, add the pydm directory to your PYSIDE_DESIGNER_PLUGINS environment variable instead. Eventually, this will happen automatically in some kind of setup script.

Easy Installing PyDM

Using the source code

git clone https://github.com/slaclab/pydm.git
cd pydm
pip install .[all]

Using Anaconda

When using Anaconda to install PyDM at a Linux Environment it will automatically define the PYQTDESIGNERPATH environment variable pointing to /etc/pydm which will have a file named designer_plugin.py which will make all the PyDM widgets available to the Qt Designer. For more information please see our installation guide.