Ophyd Device definitions for LCLS Beamline components
Project description
PCDS Devices
Motivation
Ophyd presents a uniform set of abstractions for EPICS devices. Many devices at
the LCLS are covered by ophyd-provided classes such as EpicsMotor and
AreaDetector, but there are also many more custom and unique devices.
This repository:
- Defines unique device classes required by the LCLS, referenced by happi and our device_config database.
- Offers LCLS-tailored solutions for functionality not provided by ophyd
- Provides essential tools to aid in the creation of new devices for specific applications
- Acts as a proving ground for features that may eventually be destined for ophyd
- ... and more!
Much of the core re-used functionality can be found in
pcdsdevices.device, pcdsdevices.interface, pcdsdevices.pseudopos,
and pcdsdevices.signal.
Installation
Install the most recent tagged build:
$ conda install -c conda-forge pcdsdevices
Install the most recent development build:
$ conda install pcdsdevices -c pcds-dev -c lightsource2-tag -c conda-forge
Or alternatively:
# Install the tagged version for the dependencies
$ conda install -c conda-forge pcdsdevices
# Clone the master branch:
$ git clone https://github.com/pcdshub/pcdsdevices
$ cd pcdsdevices
# And perform a development install:
$ python -m pip install -e .
Testing
Testing from psbuild-rhel7
Use the pcds conda environment:
$ source /cds/group/pcds/pyps/conda/pcds_conda
Testing without PCDS servers
Ensure you have all of the development requirements available:
$ pip install -r dev-requirements.txt
General testing steps
$ git clone https://github.com/pcdshub/pcdsdevices
$ cd pcdsdevices
# Switch to a branch that reflects what you're working on:
$ git checkout -b my_feature_branch_name
# Make your changes to files
# Install pre-commit to allow for style checks before committing
$ pre-commit install
# Run the test suite
$ python run_tests.py -v
If all is well, commit and push your changes.
If pre-commit complains about an issue, you will need to resolve it and try again.
$ git commit -a -m "ENH: my new feature"
$ git remote add my_remote git@github.com:my_username/pcdsdevices
$ git push -u my_remote my_feature_branch_name
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file pcdsdevices-7.4.2.tar.gz.
File metadata
- Download URL: pcdsdevices-7.4.2.tar.gz
- Upload date:
- Size: 416.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.9.17
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | d20683a6af45e72d71a10cb36e811cc5c2fbb8586e46da191a85421204d4576c |
|
| MD5 | f40ab851b6eeefe28c93ae4ddfe75bf7 |
|
| BLAKE2b-256 | fdba070534ef6d848d8e51b483ebba48a14964c49492c39fe22f59fbbb752a2d |
Provenance
File details
Details for the file pcdsdevices-7.4.2-py3-none-any.whl.
File metadata
- Download URL: pcdsdevices-7.4.2-py3-none-any.whl
- Upload date:
- Size: 461.7 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.9.17
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | fd14806606d2808be5783b360de387b976fafe1d5a86fdf2d88d4cf550b565fc |
|
| MD5 | f8884ddec125d608c335320d9ff747df |
|
| BLAKE2b-256 | 97856967b624bc4feb36b9e4cc3aa7354cac550e404adb31a73c5732e9dfc7b0 |
