Difference between revisions of "Controls Software Documentation"

From Beam Line Controls
Jump to navigation Jump to search
 
(19 intermediate revisions by the same user not shown)
Line 45: Line 45:
** General repository: https://github.com/bluesky
** General repository: https://github.com/bluesky
** bluesky-specific documentation: https://blueskyproject.io/bluesky/
** bluesky-specific documentation: https://blueskyproject.io/bluesky/
* Python packages:
** bluesky source: https://github.com/bluesky/bluesky
** bluesky source: https://github.com/bluesky/bluesky
* Training:
** ophyd source: https://github.com/bluesky/ophyd
** databroker source: https://github.com/bluesky/databroker
* Trainings:
** NSLS-II Sandbox for tutorials: https://try.nsls2.bnl.gov
** NSLS-II Sandbox for tutorials: https://try.nsls2.bnl.gov
*** Try Bluesky in your internet browser (no local python required for this)
*** Try Bluesky in your internet browser (no local python required for this)
Line 55: Line 58:
** [https://blueskyproject.io/hklpy/examples/index.html Diffractometer examples]
** [https://blueskyproject.io/hklpy/examples/index.html Diffractometer examples]
* Queue server:
* Queue server:
** [https://blueskyproject.io/bluesky-queueserver/ queueserver - Server for queueing plans.]
** [https://blueskyproject.io/bluesky-queueserver/ queueserver - Server for queueing plans]
** [https://blueskyproject.io/bluesky-queueserver-api/ API documentation]
** [https://blueskyproject.io/bluesky-queueserver-api/ API documentation]
* Tiled:
* Tiled:
** [https://blueskyproject.io/tiled/ Data server for databroker and directories with data files.]
** [https://blueskyproject.io/tiled/ Data server for databroker and directories with data files]
** [https://github.com/BCDA-APS/tiled-template Template for creating a local tiled data server at APS.]
** [https://github.com/BCDA-APS/tiled-template Template for creating a local tiled data server at APS]


===APS===
===Bluesky at APS===
* Status of Bluesky at the APS: [https://anl.box.com/s/yh6yp0dihz5xz89hphxc4qlit2d8ngs7 P. Jemian Talk 2022-09-19]
* Documentation:
* [https://github.com/BCDA-APS/use_bluesky#use_bluesky Installation Steps for APS users]
** Status of Bluesky at the APS: [https://anl.box.com/s/yh6yp0dihz5xz89hphxc4qlit2d8ngs7 P. Jemian Talk 2022-09-19]
* [https://bcda-aps.github.io/apstools/latest/ apstools - Various Python tools for use with Bluesky at the APS.]
** [https://bcda-aps.github.io/bluesky_training/instrument/_install_new_instrument.html Installation Steps]
* [https://bcda-aps.github.io/apstools/examples/index.html Guides, How-Tos, and other examples.]
** apstools: [https://bcda-aps.github.io/apstools/latest/index.html Guides, How-Tos, and other examples]
** Bluesky training:
** bluesky training: [https://bcda-aps.github.io/bluesky_training/index.html Getting started with Bluesky]
*** [https://github.com/BCDA-APS/bluesky_training/blob/main/APS_Bluesky_101.md APS Bluesky 101 course (2021).]
* Source code:
*** [https://github.com/BCDA-APS/bluesky_source code repository]
** apstools: [https://github.com/BCDA-APS/apstools https://github.com/BCDA-APS/apstools]
* [https://github.com/BCDA-APS/bluesky_training/tree/main/bluesky Template for new instrument description]  
** bluesky training: [https://github.com/BCDA-APS/bluesky_training https://github.com/BCDA-APS/bluesky_training]
** Work in progress.
** Includes configuration for IPython console, Jupyter notebook, and bluesky-queueserver.


===PyDM===
===Python Display Manager PyDM===
** [https://slaclab.github.io/pydm/ Python Display Manager]
* [https://slaclab.github.io/pydm/ PyDM Documentation]
** [https://github.com/BCDA-APS/adl2pydm adl2pydm - Convert MEDM's .adl files to PyDM's .ui format.]
* [https://github.com/BCDA-APS/adl2pydm adl2pydm - Convert MEDM's .adl files to PyDM's .ui format]


==Python support==
==Python support==

Latest revision as of 19:31, 22 May 2023

This page exists to collect links to documentation about the instrument control system EPICS, its modules and related libraries (synApps, areaDetector), as used at the Advanced Photon Source.

Documentation referenced should be appropriate for beamline scientists, as opposed to only EPICS developers. New deployments should prefer EPICSv7, the latest release series.

See also the extensive resources from past EPICS Collaboration meetings.

EPICS Base

synApps (aka EPICS Support)

areaDetector

Deploying, troubleshooting, and maintaining IOCs

Pre-built IOCs

Docker images

Virtual Machines

Maintaining Documentation

APS ESAF & Proposal - Read-only interface

Bluesky

Bluesky Framework

Bluesky at APS

Python Display Manager PyDM

Python support

Channel Access

PV Access

General

Retrieved from "https://wiki-ext.aps.anl.gov/blc/index.php?title=Controls_Software_Documentation&oldid=583"