pcdsdevices

Name	pcdsdevices JSON
Version	8.6.0 JSON
	download
home_page	None
Summary	Ophyd Device definitions for LCLS Beamline components
upload_time	2024-09-16 23:13:59
maintainer	None
docs_url	None
author	SLAC National Accelerator Laboratory
requires_python	>=3.9
license	Copyright (c) 2023, The Board of Trustees of the Leland Stanford Junior University, through SLAC National Accelerator Laboratory (subject to receipt of any required approvals from the U.S. Dept. of Energy). All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: (1) Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. (2) Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. (3) Neither the name of the Leland Stanford Junior University, SLAC National Accelerator Laboratory, U.S. Dept. of Energy nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER, THE UNITED STATES GOVERNMENT, OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. You are under no obligation whatsoever to provide any bug fixes, patches, or upgrades to the features, functionality or performance of the source code ("Enhancements") to anyone; however, if you choose to make your Enhancements available either publicly, or directly to SLAC National Accelerator Laboratory, without imposing a separate written license agreement for such Enhancements, then you hereby grant the following license: a non-exclusive, royalty-free perpetual license to install, use, modify, prepare derivative works, incorporate into other computer software, distribute, and sublicense such Enhancements or derivative works thereof, in binary and source code form.
keywords
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            <h1 align="center">PCDS Devices</h1>

<div align="center">
  <strong>Collection of Ophyd Device subclasses for IOCs unique to PCDS</strong>
</div>

<p align="center">
  <a href="#motivation">Motivation</a> •
  <a href="#installation">Installation</a>
</p>

## 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](https://github.com/pcdshub/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:

```bash
$ conda install -c conda-forge pcdsdevices
```

Install the most recent development build:

```bash
$ conda install pcdsdevices -c pcds-dev -c lightsource2-tag -c conda-forge
```

Or alternatively:

```bash
# 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:

```bash
$ source /cds/group/pcds/pyps/conda/pcds_conda
```

### Testing without PCDS servers

Ensure you have all of the development requirements available:

```bash
$ pip install -r dev-requirements.txt
```

### General testing steps

```bash
$ 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.

```bash
$ 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
```

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "pcdsdevices",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.9",
    "maintainer_email": null,
    "keywords": null,
    "author": "SLAC National Accelerator Laboratory",
    "author_email": null,
    "download_url": "https://files.pythonhosted.org/packages/a6/d0/8f99e3920db78416c471b18024386adb30f29ed406c520cef1d9120b0209/pcdsdevices-8.6.0.tar.gz",
    "platform": null,
    "description": "<h1 align=\"center\">PCDS Devices</h1>\n\n<div align=\"center\">\n  <strong>Collection of Ophyd Device subclasses for IOCs unique to PCDS</strong>\n</div>\n\n<p align=\"center\">\n  <a href=\"#motivation\">Motivation</a> \u2022\n  <a href=\"#installation\">Installation</a>\n</p>\n\n## Motivation\n\nOphyd presents a uniform set of abstractions for EPICS devices. Many devices at\nthe LCLS are covered by ophyd-provided classes such as ``EpicsMotor`` and\n``AreaDetector``, but there are also many more custom and unique devices.\n\nThis repository:\n\n* Defines unique device classes required by the LCLS, referenced by happi\n  and our [device_config](https://github.com/pcdshub/device_config/) database.\n* Offers LCLS-tailored solutions for functionality not provided by ophyd\n* Provides essential tools to aid in the creation of new devices for specific\n  applications\n* Acts as a proving ground for features that may eventually be destined for\n  ophyd\n* ... and more!\n\nMuch of the core re-used functionality can be found in\n``pcdsdevices.device``, ``pcdsdevices.interface``, ``pcdsdevices.pseudopos``,\nand ``pcdsdevices.signal``.\n\n## Installation\n\nInstall the most recent tagged build:\n\n```bash\n$ conda install -c conda-forge pcdsdevices\n```\n\nInstall the most recent development build:\n\n```bash\n$ conda install pcdsdevices -c pcds-dev -c lightsource2-tag -c conda-forge\n```\n\nOr alternatively:\n\n```bash\n# Install the tagged version for the dependencies\n$ conda install -c conda-forge pcdsdevices\n\n# Clone the master branch:\n$ git clone https://github.com/pcdshub/pcdsdevices\n$ cd pcdsdevices\n\n# And perform a development install:\n$ python -m pip install -e .\n```\n\n## Testing\n\n### Testing from psbuild-rhel7\n\nUse the pcds conda environment:\n\n```bash\n$ source /cds/group/pcds/pyps/conda/pcds_conda\n```\n\n### Testing without PCDS servers\n\nEnsure you have all of the development requirements available:\n\n```bash\n$ pip install -r dev-requirements.txt\n```\n\n### General testing steps\n\n```bash\n$ git clone https://github.com/pcdshub/pcdsdevices\n$ cd pcdsdevices\n\n# Switch to a branch that reflects what you're working on:\n$ git checkout -b my_feature_branch_name\n\n# Make your changes to files\n# Install pre-commit to allow for style checks before committing\n$ pre-commit install\n\n# Run the test suite\n$ python run_tests.py -v\n```\n\nIf all is well, commit and push your changes.\n\nIf pre-commit complains about an issue, you will need to resolve it and try\nagain.\n\n```bash\n$ git commit -a -m \"ENH: my new feature\"\n$ git remote add my_remote git@github.com:my_username/pcdsdevices\n$ git push -u my_remote my_feature_branch_name\n```\n",
    "bugtrack_url": null,
    "license": "Copyright (c) 2023, The Board of Trustees of the Leland Stanford Junior University, through SLAC National Accelerator Laboratory (subject to receipt of any required approvals from the U.S. Dept. of Energy). All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:  (1) Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.  (2) Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.  (3) Neither the name of the Leland Stanford Junior University, SLAC National Accelerator Laboratory, U.S. Dept. of Energy nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS \"AS IS\" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER, THE UNITED STATES GOVERNMENT, OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.  You are under no obligation whatsoever to provide any bug fixes, patches, or upgrades to the features, functionality or performance of the source code (\"Enhancements\") to anyone; however, if you choose to make your Enhancements available either publicly, or directly to SLAC National Accelerator Laboratory, without imposing a separate written license agreement for such Enhancements, then you hereby grant the following license: a non-exclusive, royalty-free perpetual license to install, use, modify, prepare derivative works, incorporate into other computer software, distribute, and sublicense such Enhancements or derivative works thereof, in binary and source code form. ",
    "summary": "Ophyd Device definitions for LCLS Beamline components",
    "version": "8.6.0",
    "project_urls": null,
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "e2489abcb85f451c53581297a33c62f122a60665e865a500c94e45fc2835affa",
                "md5": "13220ef1a4368feaa935cb8f5cc31742",
                "sha256": "a12a7ba9172341cade9559c49152f3d3c70044c9b2f194d42acc6d05e4f1a657"
            },
            "downloads": -1,
            "filename": "pcdsdevices-8.6.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "13220ef1a4368feaa935cb8f5cc31742",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.9",
            "size": 510417,
            "upload_time": "2024-09-16T23:13:58",
            "upload_time_iso_8601": "2024-09-16T23:13:58.347742Z",
            "url": "https://files.pythonhosted.org/packages/e2/48/9abcb85f451c53581297a33c62f122a60665e865a500c94e45fc2835affa/pcdsdevices-8.6.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "a6d08f99e3920db78416c471b18024386adb30f29ed406c520cef1d9120b0209",
                "md5": "0dfeed8147bef4ac115285537c0b5f03",
                "sha256": "066310c2894cc36a208fc8e1292cd44bc4f0a16ebfd83f46498aea78d9635933"
            },
            "downloads": -1,
            "filename": "pcdsdevices-8.6.0.tar.gz",
            "has_sig": false,
            "md5_digest": "0dfeed8147bef4ac115285537c0b5f03",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.9",
            "size": 459058,
            "upload_time": "2024-09-16T23:13:59",
            "upload_time_iso_8601": "2024-09-16T23:13:59.887444Z",
            "url": "https://files.pythonhosted.org/packages/a6/d0/8f99e3920db78416c471b18024386adb30f29ed406c520cef1d9120b0209/pcdsdevices-8.6.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-09-16 23:13:59",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "pcdsdevices"
}