Skip to content
Python Display Manager
Python Other
  1. Python 99.9%
  2. Other 0.1%
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github DOC: Improve README.md, add GitHub issues templates, contributing gui… Oct 31, 2018
conda-recipe CI: CondaEnvironment task is deprecated. (#567) Nov 4, 2019
docs DOC: Add documentation for the plot curve editor. Nov 13, 2019
examples FIX: Disable autoSIPPrefix for TimePlot. Nov 12, 2019
pydm ENH: Add tooltip when using Qt Designer to point users to the Curve E… Nov 13, 2019
pydm_launcher
.coveragerc CI: Add .coveragerc to control which files should be part of report. Apr 16, 2018
.gitattributes FIX: PyDM launcher and other issues with Windows (#199) Dec 15, 2017
.gitignore TST: Add tests for PyDMLabel and DisplayFormat (#285) Apr 10, 2018
LICENSE.md Another year, another license bump. Oct 4, 2019
MANIFEST.in Add dev-requirements.txt to MANIFEST.in Jun 14, 2019
README.md DOCS: Add instructions on how to run the tests and build the docs int… Apr 18, 2019
azure-build-template.yml CI: CondaEnvironment task is deprecated. (#567) Nov 4, 2019
azure-pipelines.yml
azure-test-template-win.yml CI: Add back codecov upload. Nov 6, 2019
azure-test-template.yml CI: Add back codecov upload. Nov 6, 2019
dev-requirements.txt CI: CondaEnvironment task is deprecated. (#567) Nov 4, 2019
docs-requirements.txt CI: Adding doctr as dependency for docs-requirements.txt (#126) Oct 4, 2017
github_deploy_key.enc Fix versioneer version number and some warnings at docs (#125) Oct 4, 2017
pydm_designer_plugin.py FIX: Renaming designer_plugin to pydm_designer_plugin to avoid collis… Nov 2, 2018
requirements.txt MNT: move to importing from qtpy instead of PyQt5 Sep 6, 2018
run_tests.py FIX: Don't blow up if macros is None of empty. Dec 19, 2018
setup.cfg FIX: Fixing the tag_prefix at setup.cfg after deciding that all the t… Dec 13, 2017
setup.py MNT: Remove from and add pulling info from Apr 18, 2019
versioneer.py ENH: Base plugin (#81) Sep 23, 2017

README.md

Build Status codecov

PyDM: Python Display Manager

PyDM is a PyQt-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/PySide). All tests are performed with PyQt5.

Prerequisites

  • Python 2.7 or 3.6+
  • Qt 5.6 or higher
  • qtpy
  • PyQt5 >= 5.7 or any other Qt Python wrapper.

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 PyQt plugin for Designer installed. This usually happens automatically when you install PyQt 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'

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:

python scripts/pydm examples/home.ui

Building the Documentation Locally

In order to build the documentation you will need to instll 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 PyQt Designer Plugin. If you want to use the pydm widgets in Qt Designer, add the pydm directory (which holds designer_plugin.py) to your PYQTDESIGNERPATH environment variable. 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.

Most Recent Development Build

Anaconda-Server Badge Anaconda-Server Badge Anaconda-Server Badge Anaconda-Server Badge

conda install -c pydm-dev -c conda-forge pydm

Most Recent Tagged Build

Anaconda-Server Badge Anaconda-Server Badge Anaconda-Server Badge Anaconda-Server Badge

conda install -c pydm-tag -c conda-forge pydm
You can’t perform that action at this time.