| Name | typhos JSON |
| Version |
4.1.0
JSON |
| download |
| home_page | None |
| Summary | Interface generation for ophyd devices |
| upload_time | 2024-12-20 16:59:31 |
| 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.
|
<img src="docs/source/_static/hydra.jpg" width="200" height="250" align="right"/>
<h1>Typhos</h1>
<h3>Automated User Interface Creation from Ophyd Devices</h3>
</p>
EPICS is a flexible and powerful controls system that gives access to experimental
information, however, the relation and meaning of process variables is often
obscure. Many of the user interfaces for EPICS information reflect this, as
walls of buttons and flashing lights bombard the user with little thought to
structure or cohesion.
Typhos addresses this by providing an automated way to generate screens based
on a provided hierarchy of devices and signals. Built using PyDM, a PyQt based
display manager developed at SLAC National Laboratory, Typhos utilizes a large
toolkit of widgets to display EPICS information. For each process variable, a
corresponding widget is created based on; the importance to the average
operator, the type of value the EPICS PV will return, and whether a user should
be allowed to write to the variable. These widgets are then placed in a
convenient tab-based system to only show the necessary information for basic
function, but still allow access to more advanced signals.
Instead of reinventing a new way to specify device structures, Typhos uses
`Ophyd`, a library to abstract EPICS information into consistently structured
Python objects. Originally built for scripting experimental procedures at
NSLSII, Ophyd represents devices as combinations of components which are
either signals or nested devices. Then, either at runtime or by using the
defaults of the representative Python class, these signals are sorted into
different categories based on their relevance to operators. Typhos uses this
information to craft user interfaces.
## Installation
Recommended installation on Linux:
```
conda install typhos -c conda-forge -c pcds-tag
```
All `-tag` channels have `-dev` counterparts for bleeding edge installations.
Both `requirements.txt` and optional `dev-requirements.txt` are kept up to date
as well for those who prefer installation via `pip`
typhos utilizes PyDM's designer widget entrypoints. This means that if you
have PyDM working correctly with the Qt Designer, typhos widgets will also be
available. No further customization or environment settings are required.
`happi` is an optional dependency but is recommended. This must be installed
manually if not using the CONDA recipe.
### Qt Installation
There have been some observed inconsistencies between installations of `Qt`
available on `pip`, `defaults` and `conda-forge`. It is recommended that if you
want to use the full `typhos` feature to install via `conda-forge`. We have
found this the most reliable, especially when it comes to using the
`QtDesigner`. It is worth noting that since this library uses `qtpy` as an
interface layer to the various options for Qt Python bindings, the bare
requirements will not install a specific one for you. The testing suite runs
using `PyQt5`.
## Getting Started
Creating your first ``typhos`` panel for an``ophyd.Device`` only takes two
lines:
```python
import sys
from ophyd.sim import motor
from qtpy.QtWidgets import QApplication
import typhos
# Create our application
app = QApplication.instance() or QApplication(sys.argv)
typhos.use_stylesheet() # Optional
suite = typhos.TyphosSuite.from_device(motor)
# Launch
suite.show()
app.exec_()
```
## Available Widgets
Typhos has three major building blocks that combine into the final display seen
by the operator:
* ``TyphosSuite``: The overall view for a Typhos window. It allows the
operator to view all of the loaded components and tools
* ``TyphosDeviceDisplay``: This is the widget created for a standard
``ophyd.Device``. Signals are organized based on their
``Kind`` and description.
* ``typhos.tools``: These are widgets that interface with external
applications. While you may have other GUIs for these systems,
``typhos.tools`` are built especially to handle the handshaking between all the
information stored on your device and the tool you are interfacing with. This
saves your operator clicks and ensures consistency in use.
### Initialization Pattern
All three of the widgets listed above share a similar API for creation.
Instantiating the object by itself handles loading the container widgets and
placing them in the correct place, but these do not accept ``ophyd.Device``
arguments. The reason for this is to ensure that we can use all of the
``typhos`` screens as templates, and regardless or not of whether you have an
``ophyd.Device`` you can always populate the screens by hand. If you do in fact
have an ``ophyd.Device`` every class has an ``add_device`` method and
alternatively and be constructed using the ``from_device`` classmethod.
## Related Projects
[**PyDM**](https://github.com/slaclab/pydm) - PyQT Display Manager for EPICS information
[**Ophyd**](https://github.com/NSLS-II/ophyd) - Device abstraction for Experimental Control
Raw data
{
"_id": null,
"home_page": null,
"name": "typhos",
"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/2b/e3/5a792923eabaeff63c7c8e2d57f553c6d539bb28a240a95040e63b337d07/typhos-4.1.0.tar.gz",
"platform": null,
"description": "<img src=\"docs/source/_static/hydra.jpg\" width=\"200\" height=\"250\" align=\"right\"/>\n <h1>Typhos</h1>\n <h3>Automated User Interface Creation from Ophyd Devices</h3>\n</p>\n\nEPICS is a flexible and powerful controls system that gives access to experimental\ninformation, however, the relation and meaning of process variables is often\nobscure. Many of the user interfaces for EPICS information reflect this, as\nwalls of buttons and flashing lights bombard the user with little thought to\nstructure or cohesion.\n\nTyphos addresses this by providing an automated way to generate screens based\non a provided hierarchy of devices and signals. Built using PyDM, a PyQt based\ndisplay manager developed at SLAC National Laboratory, Typhos utilizes a large\ntoolkit of widgets to display EPICS information. For each process variable, a\ncorresponding widget is created based on; the importance to the average\noperator, the type of value the EPICS PV will return, and whether a user should\nbe allowed to write to the variable. These widgets are then placed in a\nconvenient tab-based system to only show the necessary information for basic\nfunction, but still allow access to more advanced signals.\n\nInstead of reinventing a new way to specify device structures, Typhos uses\n`Ophyd`, a library to abstract EPICS information into consistently structured\nPython objects. Originally built for scripting experimental procedures at\nNSLSII, Ophyd represents devices as combinations of components which are\neither signals or nested devices. Then, either at runtime or by using the\ndefaults of the representative Python class, these signals are sorted into\ndifferent categories based on their relevance to operators. Typhos uses this\ninformation to craft user interfaces.\n\n## Installation\nRecommended installation on Linux:\n```\nconda install typhos -c conda-forge -c pcds-tag\n```\nAll `-tag` channels have `-dev` counterparts for bleeding edge installations.\nBoth `requirements.txt` and optional `dev-requirements.txt` are kept up to date\nas well for those who prefer installation via `pip`\n\ntyphos utilizes PyDM's designer widget entrypoints. This means that if you\nhave PyDM working correctly with the Qt Designer, typhos widgets will also be\navailable. No further customization or environment settings are required.\n\n`happi` is an optional dependency but is recommended. This must be installed\nmanually if not using the CONDA recipe.\n\n### Qt Installation\nThere have been some observed inconsistencies between installations of `Qt`\navailable on `pip`, `defaults` and `conda-forge`. It is recommended that if you\nwant to use the full `typhos` feature to install via `conda-forge`. We have\nfound this the most reliable, especially when it comes to using the\n`QtDesigner`. It is worth noting that since this library uses `qtpy` as an\ninterface layer to the various options for Qt Python bindings, the bare\nrequirements will not install a specific one for you. The testing suite runs\nusing `PyQt5`.\n\n## Getting Started\nCreating your first ``typhos`` panel for an``ophyd.Device`` only takes two\nlines:\n\n```python\nimport sys\nfrom ophyd.sim import motor\nfrom qtpy.QtWidgets import QApplication\nimport typhos\n\n# Create our application\napp = QApplication.instance() or QApplication(sys.argv)\ntyphos.use_stylesheet() # Optional\nsuite = typhos.TyphosSuite.from_device(motor)\n\n# Launch\nsuite.show()\napp.exec_()\n```\n\n## Available Widgets\nTyphos has three major building blocks that combine into the final display seen\nby the operator:\n\n* ``TyphosSuite``: The overall view for a Typhos window. It allows the\noperator to view all of the loaded components and tools\n\n* ``TyphosDeviceDisplay``: This is the widget created for a standard\n``ophyd.Device``. Signals are organized based on their\n``Kind`` and description.\n\n* ``typhos.tools``: These are widgets that interface with external\napplications. While you may have other GUIs for these systems,\n``typhos.tools`` are built especially to handle the handshaking between all the\ninformation stored on your device and the tool you are interfacing with. This\nsaves your operator clicks and ensures consistency in use.\n\n### Initialization Pattern\nAll three of the widgets listed above share a similar API for creation.\nInstantiating the object by itself handles loading the container widgets and\nplacing them in the correct place, but these do not accept ``ophyd.Device``\narguments. The reason for this is to ensure that we can use all of the\n``typhos`` screens as templates, and regardless or not of whether you have an\n``ophyd.Device`` you can always populate the screens by hand. If you do in fact\nhave an ``ophyd.Device`` every class has an ``add_device`` method and\nalternatively and be constructed using the ``from_device`` classmethod.\n\n## Related Projects\n[**PyDM**](https://github.com/slaclab/pydm) - PyQT Display Manager for EPICS information\n\n[**Ophyd**](https://github.com/NSLS-II/ophyd) - Device abstraction for Experimental Control\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": "Interface generation for ophyd devices",
"version": "4.1.0",
"project_urls": null,
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "be33d554b18ab8ca1018dc523b52ffb061f795764dd584d2d2628e747d9b36da",
"md5": "298944ac2663b71995895d32deb53843",
"sha256": "fb0ea6f239ec98fb267a42effec2405ebcdb378993a66791ee3feeab10ac828a"
},
"downloads": -1,
"filename": "typhos-4.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "298944ac2663b71995895d32deb53843",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 724224,
"upload_time": "2024-12-20T16:59:30",
"upload_time_iso_8601": "2024-12-20T16:59:30.334143Z",
"url": "https://files.pythonhosted.org/packages/be/33/d554b18ab8ca1018dc523b52ffb061f795764dd584d2d2628e747d9b36da/typhos-4.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "2be35a792923eabaeff63c7c8e2d57f553c6d539bb28a240a95040e63b337d07",
"md5": "5384b50c776f590e1c4853ebe1bcc82d",
"sha256": "7512ffcb05567b11081ac1cf3dd6dd523c80c3898a5c3d418c1c89f84d075cea"
},
"downloads": -1,
"filename": "typhos-4.1.0.tar.gz",
"has_sig": false,
"md5_digest": "5384b50c776f590e1c4853ebe1bcc82d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 1264975,
"upload_time": "2024-12-20T16:59:31",
"upload_time_iso_8601": "2024-12-20T16:59:31.951220Z",
"url": "https://files.pythonhosted.org/packages/2b/e3/5a792923eabaeff63c7c8e2d57f553c6d539bb28a240a95040e63b337d07/typhos-4.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-20 16:59:31",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "typhos"
}
