Difference between revisions of "Controls Software Documentation"

From Beam Line Controls
Jump to navigation Jump to search
 
(28 intermediate revisions by the same user not shown)
Line 41: Line 41:
==Bluesky==
==Bluesky==
===Bluesky Framework===
===Bluesky Framework===
* [https://blueskyproject.io Bluesky home page]
* Documentation:
* [https://try.nsls2.bnl.gov Try Bluesky in a web browser (from NSLS-II)]
** General documentation: https://blueskyproject.io/
** General repository: https://github.com/bluesky
** bluesky-specific documentation: https://blueskyproject.io/bluesky/
* Python packages:
** bluesky source: https://github.com/bluesky/bluesky
** 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
*** Try Bluesky in your internet browser (no local python required for this)
*** Sandbox is publicly accessible
** Also: https://blueskyproject.io/tutorials/
* hklpy:
* hklpy:
** [https://blueskyproject.io/hklpy/ Bluesky's diffractometer support]
** [https://blueskyproject.io/hklpy/ Bluesky's diffractometer support]
* [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===
** [https://github.com/BCDA-APS/use_bluesky#use_bluesky Installation Steps for APS users]
* Documentation:
** [https://bcda-aps.github.io/apstools/latest/ apstools - Various Python tools for use with Bluesky at the APS.]
** Status of Bluesky at the APS: [https://anl.box.com/s/yh6yp0dihz5xz89hphxc4qlit2d8ngs7 P. Jemian Talk 2022-09-19]
** [https://bcda-aps.github.io/apstools/examples/index.html Guides, How-Tos, and other examples.]
** [https://bcda-aps.github.io/bluesky_training/instrument/_install_new_instrument.html Installation Steps]
** [https://github.com/BCDA-APS/bluesky_training/blob/main/APS_Bluesky_101.md APS Bluesky 101 (from 2021).]
** apstools: [https://bcda-aps.github.io/apstools/latest/index.html Guides, How-Tos, and other examples]
** [https://github.com/BCDA-APS/bluesky_training Bluesky training for APS users]
** bluesky training: [https://bcda-aps.github.io/bluesky_training/index.html Getting started with Bluesky]
** [https://github.com/BCDA-APS/bluesky_training/tree/main/bluesky Template for new instrument description]  
* Source code:
*** Work in progress.
** apstools: [https://github.com/BCDA-APS/apstools https://github.com/BCDA-APS/apstools]
*** Includes configuration for IPython console, Jupyter notebook, and bluesky-queueserver.
** bluesky training: [https://github.com/BCDA-APS/bluesky_training https://github.com/BCDA-APS/bluesky_training]
===PyDM===
 
** [https://slaclab.github.io/pydm/ Python Display Manager]
===Python Display Manager PyDM===
** [https://github.com/BCDA-APS/adl2pydm adl2pydm - Convert MEDM's .adl files to PyDM's .ui format.]
* [https://slaclab.github.io/pydm/ PyDM Documentation]
* [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"