Beam Line Controls - User contributions [en]

Beamline Controls

2026-03-18T21:25:03Z

Jemian: /* Beamline Data Pipelines */

WIKI for the APS Beamline Controls Community, maintained by the Beamline Controls Technical Working Group. 
This wiki exists to collect the output of the working group, including documentation on beamline controls software and hardware useful for APS beamline scientists and resident users.

----

===Getting Started===
* [[EPICS Cheat Sheet]]: Channel Access command-lines, noteworthy record fields & IOC shell commands.
* [[EPICS 101]]: definition of basic EPICS components ([[EPICS_101#What_is_an_IOC.3F|IOC]], [[EPICS 101#What_is_a_PV.3F|PV]], [[EPICS_101#What_is_a_record.3F|record]], [[EPICS 101#What_is_a_database.3F|database]]).
* [[IOC 101]]: learn how to create your own IOC.
* [[Git_101|Git 101]]: git refresher (basic workflow, commands, and more).

===Beamline Controls Documentation===

* [[EPICS networking]]: basic overview of how to control the network paths used by EPICS IOCs and clients.
* [[Controls Software Documentation]]
* [[Hardware and IT Configuration]]
* [[APSU_PVs]]: Description of what process variables(PVs) have changed for PSS, EPS, and ID control for the APSU beamlines
** Mark Rivers has documented the process he used to find the relevant medm screens and the useful PVs for his beamline:
*** https://github.com/CARS-UChicago/GSECARS-EPICS/blob/master/docs/EPICS_Beamline_PVs.docx
*** https://github.com/CARS-UChicago/GSECARS-EPICS/blob/master/docs/EPICS_Beamline_PVs.pdf

===Practical Beamline Controls Training (2023)===

[[Practical_Beamline_Controls_Training#IOC_Basics|Session 1: IOC Basics]]
[[Practical_Beamline_Controls_Training#IOC_Deployment_.26_Troubleshooting|Session 2: IOC Deployment & Troubleshooting]]

===Beamline Controls Technical Working Group information===

The BC Technical Working (BCTWG) group meets monthly to review and gather feedback on possible changes in either the way BC delivers support or the technologies that BC supports. The BCTWG comprises the BC group plus interested stakeholders from XSD. In a nutshell, the main goal of the BCTWG is to improve communication between BC and its customers on topics of mutual interest.

* Box folder with slides and meeting notes (ANL only): [https://anl.box.com/s/chcn7xauil93inay8ipinbxtcckc9k9f]

* Current chairs:
** Tejas Guruswamy (XSD-DET)
** Keenan Lang (XSD-BC)
** Victoria Cooley (XSD-MPE)

===Beamline Data Pipelines===

* https://git.aps.anl.gov/groups/bdp-public/-/wikis/home
* https://git.aps.anl.gov/groups/bdp-public/-/wikis/Software-Containers (podman, docker)

Beamline Controls

2026-03-18T21:24:42Z

Jemian: /* Beamline Data Pipelines */

Controls Software Documentation

2026-03-18T19:56:38Z

Jemian: Remove link to apsbss per management directions.

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 [https://epics-controls.org/resources-and-support/documents/training/ resources from past EPICS Collaboration meetings].

==EPICS Base==
* [https://docs.epics-controls.org/en/latest/guides/EPICS_Intro.html Intro to EPICS]
* [https://docs.epics-controls.org/en/latest/guides/EPICS_Process_Database_Concepts.html EPICS Database Concepts]
* [https://docs.epics-controls.org/projects/how-tos/en/latest/getting-started/installation.html EPICS Base Getting Started (official)]
* [https://cmd-response.readthedocs.io/en/latest/epics/rpi_epics.html Installing EPICS on RaspberryPi]

==synApps (aka EPICS Support)==
* [https://epics.anl.gov/bcda/synApps/synApps_docs_all.html synApps Collected Documentation]
* [https://epics.anl.gov/bcda/synApps/synApps.html synApps deployment instructions, including use of xxx template ioc]

==areaDetector==
* [https://areadetector.github.io/areaDetector/ areaDetector Official Documentation]

==Deploying, troubleshooting, and maintaining IOCs==
* [[Troubleshooting EPICS IOCs]]
* [https://docs2bm.readthedocs.io/en/latest/source/ops/item_000_0.html simDetector Install directions (2BM)]
* [https://epics-modules.github.io/xxx/overview.html The Basics of an IOC (XXX documentation)]
* [https://gist.github.com/keenanlang/e768774cbd0a367b96281939b8a2c9ba Creation of an IOC using mkioc]
* [https://wiki.aps.anl.gov/bcda/index.php/Category:TUTORIAL BCDA Tutorials (APS Internal)]

==Pre-built IOCs==
===Docker images===
* EPICS Base 7.0.5, synApps 6.2: [https://github.com/prjemian/epics-docker/tree/main/v1.1/n3_synApps#readmemd standard xxx], [https://github.com/prjemian/epics-docker/tree/main/v1.1/n5_custom_synApps#readmemd customized]
* EPICS Base 7.0.5, synApps 6.2, area detector 3.10: [https://github.com/prjemian/epics-docker/tree/main/v1.1/n4_areaDetector#readmemd standard], [https://github.com/prjemian/epics-docker/tree/main/v1.1/n6_custom_areaDetector#readmemd custom]
===Virtual Machines===
* [https://github.com/BCDA-APS/epics-bluesky-vm/blob/main/install_vm.md APS Bluesky 101 training VM image.]

==Maintaining Documentation==
* [https://bctwg.readthedocs.io/en/latest/index.html ReadTheDocs tutorial and example site]

==Bluesky==
===Bluesky Framework===
* Documentation:
** 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:
** [https://blueskyproject.io/hklpy/ Bluesky's diffractometer support]
** [https://blueskyproject.io/hklpy/examples/index.html Diffractometer examples]
* Queue server:
** [https://blueskyproject.io/bluesky-queueserver/ queueserver - Server for queueing plans]
** [https://blueskyproject.io/bluesky-queueserver-api/ API documentation]
* Tiled:
** [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]

===Bluesky at APS===
* Documentation:
** Status of Bluesky at the APS: [https://anl.box.com/s/yh6yp0dihz5xz89hphxc4qlit2d8ngs7 P. Jemian Talk 2022-09-19]
** [https://bcda-aps.github.io/bluesky_training/instrument/_install_new_instrument.html Installation Steps]
** apstools: [https://bcda-aps.github.io/apstools/latest/index.html Guides, How-Tos, and other examples]
** bluesky training: [https://bcda-aps.github.io/bluesky_training/index.html Getting started with Bluesky]
* Source code:
** apstools: [https://github.com/BCDA-APS/apstools https://github.com/BCDA-APS/apstools]
** bluesky training: [https://github.com/BCDA-APS/bluesky_training https://github.com/BCDA-APS/bluesky_training]

===Python Display Manager PyDM===
* [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==
===Channel Access===
* [https://pyepics.github.io/pyepics/ PyEpics - Python interface for Channel Access based on libca and libCom.]
* [https://caproto.github.io/caproto/v0.8.1/ caproto - Python interface for Channel Access in pure Python.]
===PV Access===
* [https://mdavidsaver.github.io/p4p/ p4p - Python interface for PV Access]
* [https://github.com/epics-base/pvaPy pvapy - Python interface for PV Access, also provides CA interface]
===General===
* [https://bcdamenu.readthedocs.io/ bcdamenu - GUI menu to beam line software, such as synoptic display.]
* [https://github.com/EPICS-synApps/support/tree/master/utils/mdaPythonUtils mdaPythonUtils - Read .mda data files into Python.]
* [https://github.com/prjemian/pvMail PvMail - Watch an EPICS PV. Send email when it changes from 0 to 1.]
* [https://github.com/BCDA-APS/pvview pvView - Display one or more EPICS PVs in a PyDM GUI window as a table.]
* [https://github.com/BCDA-APS/pvWebMonitor pvWebMonitor - Post EPICS PVs to read-only (static) web site.]
* [https://prjemian.github.io/punx/ punx - Python Utilities for NeXus HDF5 files: validation, structure, hierarchy.]
* [https://prjemian.github.io/pyRestTable/ pyRestTable - Format a nice table in reST (reStructuredText) from Python.]
* [https://prjemian.github.io/pysumreg/ pysumreg - Statistics of list of (x,y) pairs from calculator-style summation registers.]
* [https://github.com/prjemian/spec2nexus/ spec2nexus - Read SPEC data files into Python, write NeXus data file.]

IOC 101

2025-02-27T20:33:36Z

Jemian:

== What is an IOC ==

For a basic description, see [https://wiki-ext.aps.anl.gov/blc/index.php?title=EPICS_101#What_is_an_IOC.3F Epics 101]
[[File:EPICS_basics_PV_diagram.png|right|thumb|700px]]

 
== How does one create an IOC? ==

There are multiple ways to create an IOC, but no one does it from scratch:

=== The EPICS base approach ===

Not recommended: it creates a bare bones IOC but requires more knowledge of the EPICS build system to get started:
::'''<code>makeBaseApp.pl</code>'''
* Must be run multiple times
* Creates IOC contents in the current directory
* synApps support needs to be added manually

=== The synApps approach ===

It is based on the ''xxx'' module and designed to give you a usable IOC with as little effort as possible:
:::'''<code>/APSshare/bin/mkioc</code>'''

* A single command leaves you with an IOC you can build:

$/APSshare/bin/mkioc -n -f -s 6-2-1 kmp

Usage: mkioc [options] ioc_name
-h print this message
-v print the version
-f create a fresh git repo without an xxx remote
-g default to creating gitlab repo and pushing ioc
-n default to not creating gitlab repo and pushing ioc
-s <version> use a specific synApps version

* Creates a top-level IOC directory in the current directory
* Common synApps support is included by default (common records/modules such as '''alive''', '''sscan''', '''calc'''...)
* '''<code>mkioc</code>''' will ask you questions if you run it without options

Note: The BCDA convention is to name development IOCs using the developer's initials (here we will use either ''xxx'' or ''kmp'').

 

== IOC Layout ==

=== Overview ===

The IOC layout can be overwhelming and confusing to those who aren’t yet familiar with it. The EPICS build system creates many directories, making it harder to find the important directories.
Important files are often buried multiple directories down from the top-level. It is helpful to look at subsets of the IOC directory.

 
Note:
* '''build''': building an IOC is the action of compiling i.e. generating the binary <code>bin/rhel#-x86_64/xxxApp</code> (plus other build products as described below) by using the command '''<code>make</code>'''.
* '''run''': running an IOC is the action of running the binary along with a startup script of iocsh commands (usually called '''<code>st.cmd</code>''')

 
Note:
* Any change in the build configuration ('''Orange folders''') requires to recompile the IOC by issuing a '''<code>make</code>'''.
* Any change in the runtime configuration ('''Green folders''') requires to reboot the IOC.

[[File:IOCtree.jpg|right|thumb|300px|xxx IOC tree]]

=== Build configuration ===

'''Orange folders:'''
* '''<code>xxx/configure</code>''':
:contains the files that specify which versions of EPICS base and EPICS modules should be used when building the IOC.
* '''<code>xxx/xxxApp/Db</code>''':
:contains local databases (and associated autosave files) and protocol files used by the IOC.
* '''<code>xxx/xxxApp/src</code>''':
:contains the Makefile that determines all of the software that gets built into the IOC binary. ; local sequence programs and other EPICS support that needs to be compiled go here.

=== Intermediate build directories ===

'''Grey folders: ''' The EPICS build system will generate '''<code>O.</code>''' files (Common, EPICS HOST and TARGET architectures) in the configure, Db, and src directories (orange directories). These directories are not needed after the IOC is built and can be removed with the '''<code>make clean</code>''' command. If they are not removed, they can be safely ignored. It is highly unlikely that you will ever need to look at any of the files in them.

=== Build products ===

'''Red folders:''' 
The EPICS build system creates top level bin, db, dbd, and lib directories:
* '''<code>xxx/bin/rhel8-x86_64</code>''':
:contains the architecture-specific IOC binary (or munch file for VxWorks IOCs).
* '''<code>xxx/db</code>''':
:contains installed database files which may or may not be used, since many IOCs reference the databases in the '''<code>Db</code>''' directory instead.
* '''<code>xxx/dbd</code>''':
:contains a single database definition file to be loaded by the IOC.
* '''<code>xxx/lib/rhel8-x86_64</code>''':
:contains architecture-specific files for EPICS modules, but should be empty for the IOC. 
The build system creates an '''<code>envPaths</code>''' file in the startup directory '''<code>iocBoot/iocxxx</code>''', which contains the locations of the modules defined in the '''<code>RELEASE</code>''' file.

=== Startup directory ===

'''Green folders:''' 
The '''<code>iocxxx</code>''' directory is referred to as the '''startup''' directory. It contains the '''<code>st.cmd</code>''' file, which is the '''runtime configuration''' for the IOC (i.e. all the files the IOC needs to load to run/start).
The IOC’s config is often broken into separate '''<code>.iocsh</code>''' (or '''<code>.cmd</code>''') files so that support can be more easily commented out and to improve readability; '''<code>substitutions</code>''' and '''<code>iocsh</code>''' files usually reside in subdirectories to reduce clutter in the startup directory.

=== Startup scripts ===

'''Blue folders:''' 
The top-level IOC directory '''<code>xxx</code>''' contains scripts that start medm & caQtDM.
The startup directory <code>'''softioc'''</code> subdirectory contains a bash script which simplifies managing the IOC on Linux.
Windows IOCs: the startup directory contains batch files to start the IOC.

Note: The startup directory can reside elsewhere.

 

== How does support get into an IOC? ==

=== Quick overview ===

[[File:EPICS_basics_linking_diagrams.png|right|thumb|800px]]
* '''<code>configure/RELEASE</code>''':
** Defines the locations of EPICS base and EPICS modules
** Often includes other RELEASE files
** '''Note: already included when using <code>mkioc</code>'''
* '''<code>xxxApp/src/Makefile</code>''':
** Specifies which database definitions ('''<code>dbd</code>''') to include
** Specifies which libraries should be included in the IOC binary
** Specifies which local code should be included in the IOC binary
** Libraries will not be included unless an associated '''<code>dbd</code>''' file is included
** The order of the libraries is important (single-pass linker)
** '''Note: unless you are adding a non-synApps module or an uncommon motor driver, you should not need to modify the <code>Makefile</code>'''
* '''<code>iocBoot/iocxxx/st.cmd</code>''':
** That is the runtime configuration file, i.e. the primary IOC config file that is sourced when the IOC is started: determines all the things that gets loaded (e.g. ''I want 7 motor records, with these names, and this resolution, etc...'')
** Name can vary slightly based on how the IOC was created
** '''Note: this is the file that you will very likely modify'''
 

=== Startup script <code>st.cmd</code> ===

Legacy IOCs often have monolithic '''<code>st.cmd</code>''' files. Newer IOCs source more '''<code>.iocsh</code>''' files from EPICS modules, which makes it easier to keep an IOC's config up-to-date.

< envPaths

dbLoadDatabase("../../dbd/iocxxxLinux.dbd")
iocxxxLinux_registerRecordDeviceDriver(pdbbase)

### Databases are loaded
### Drivers are initialized/configured here

iocInit

### Sequence programs & autosave are started here

dbl > dbl-all.txt

date

We can break it up into 3 functional zones:
* '''Zone 1''' - before '''<code>dbLoadDatabase</code>''': it is usually dedicated to setting-up the environment (e.g. defines environment variables and paths to EPICS modules).
* '''Zone 2''' - after '''<code>dbLoadDatabase</code>''' & before '''<code>iocInit</code>''': this is were most of the software is loaded (e.g. databases and substitutions template are loaded here, drivers are initialized and configured).
* '''Zone 3''' - after '''<code>iocInit</code>''': this zone is mostly empty thanks to '''<code>doAfterIocInit</code>''' from the '''<code>std</code>''' module (sequence programs and autosave get initialized here, but the calls that do the initializing appear much earlier in the startup)

Note: PVs are available during '''<code>iocInit</code>''', even though the IOC is still starting up.
 

=== Autosave ===

'''autosave''' is a synApps module that provides seamless reboot functionality. It is mostly automatic when '''<code>mkioc</code>''' is used.
PVs are saved while the IOC is running and loaded during '''<code>iocInit</code>'''.
Autosaved values overwrite database defaults.

[[File:IOC_autosave.jpg|right|thumb|300px]]

In ''xxx''-based IOCs, created using '''<code>mkioc</code>''', autosave is included by default: '''<code>common.iocsh</code>''' contains all the necessary configuration, and you will only need to modify it if you want to customize something. It also includes an '''autosaveBuild''' feature: every loaded database with associated req files ('''<code>_settings.req</code>''') are automatically added to '''<code>autosave/built_position.req</code>''' and '''<code>autosave/built_settings.req</code>''', so long as they use the correct naming convention, i.e. the '''<code>_settings.req</code>''' uses the same prefix as the database. 
The legacy request files, '''<code>autosave_position.req</code>''' and '''<code>autosave_settings.req</code>''' (that live outside the '''<code>autosave</code>''' directory) are reserved for things added manually (often empty).
Multiple '''<code>.sav</code>''' files can be created:
* Default:
** '''<code>.sav</code>''' & '''<code>.savB</code>'''
** actually restored when the IOC restarts
* Periodic:
** '''<code>.sav0</code>''', '''<code>.sav1</code>''', '''<code>.sav2</code>''', …
** overwritten cyclically; if the default one do not exist, those ones get restored.
* Dated:
** '''<code>.sav-230109-134502</code>'''
** written once at boot time

The 1st half of '''<code>common.iocsh</code>''' sets up autosave:
[https://github.com/epics-modules/xxx/blob/master/iocBoot/iocxxx/common.iocsh#L1-L46 https://github.com/epics-modules/xxx/blob/master/iocBoot/iocxxx/common.iocsh#L1-L46]
 

=== How to build & clean a Linux IOC ===

* Confirm the RHEL version
** <code> '''uname -r''' → 3.10.0-1160.62.1.'''el7'''.x86_64</code>
** <code> '''cat /etc/redhat-release''' → Red Hat Enterprise Linux Server release '''7.9'''</code>
* Set <code> EPICS_HOST_ARCH</code> environment variable
** bash: <code>'''export EPICS_HOST_ARCH=rhel7-x86_64'''</code>
** tcsh: <code>'''setenv EPICS_HOST_ARCH rhel7-x86_64'''</code>
* Initiate the build in the top-level IOC directory:
** <code>'''make'''</code>

* Remove intermediate build dirs (for the current <code> EPICS_HOST_ARCH</code>):
** <code>'''make clean'''</code>
* Remove all intermediate build dirs and top-level build directories to start fresh:
** <code>'''make distclean'''</code>
* Show all make options:
** <code>'''make help'''</code>

== Running an IOC ==
 

=== Use the script ===
 
==== Create an alias ====

Create an alias for the script (assuming PWD = IOC’s top-level dir)
:<code>$ '''alias kmp=${PWD}/iocBoot/iockmp/softioc/kmp.sh'''</code>
:<code>$ '''kmp''' </code>
:<code>Usage: kmp.sh {console|restart|run|start|caqtdm|medm|status|stop|usage}</code>

Noteworthy arguments:
* '''<code>run</code>''': Runs the IOC in the current terminal (doesn't return the command prompt). Useful for troubleshooting. Problematic for normal operation.
* '''<code>start</code>''': Runs the IOC in the background (returns the command prompt) using screen or procServ.
* '''<code>status</code>''': Tells you if the IOC is running and refuses to start if it is.

Note:
* Use the full path to the IOC’s start script so the alias can be run from any directory (bash syntax shown).
* <code>EPICS_HOST_ARCH</code> needs to still be set otherwise the IOC will not start (unless the <code>EPICS_HOST_ARCH</code> is hard-coded in the start script).

==== Start caQtDM ====

:'''<code>kmp caqtdm &</code>'''

Note: the ampersand is needed for synApps_6_2_1 IOCs, but it won’t be needed in the future because it was added to the '''<code>start_caQtDM_xxx</code>''' script.

==== Start the IOC ====

Starts the IOC in the background (using screen or procServ):

:'''<code>kmp start</code>'''

IOCs are usually run in screen or procServ so that:
* the window in which they’re started can be closed
* multiple people can connect to them
* [procServ] allows other user accounts to restart an IOC
* [procServ] allows users to connect to Windows IOCs

==== Confirm the IOC is running ====

:'''<code>kmp status</code>'''
:<code>kmp is running (pid=1281733) in a screen session (pid=1281732)</code>

Note: bugs in the deployed copy of '''<code>xxx.sh</code>''' may prevent it from detecting an IOC is running.

 

=== Connecting to an IOC’s shell ===

There are many ways to do it:

* Manually connect to an IOC running in screen from the IOC’s host
::<code>$ '''screen -x kmp'''</code>
::The -x option will connect even if someone is already connected to the screen session.
::The -r option only succeeds if no one is connected to the session.

* Connect to an IOC running in screen or procServ from the IOC’s host
::<code>$ '''kmp console'''</code>

* Connect to an IOC running in screen or procServ with logging '''from any host'''
::<code>$ '''/APSshare/bin/iocConsole.py iockmp'''</code>
::Note: iocConsole.py requires ssh access which beamline accounts don't have by default

* Manually connect to an IOC running in procServ from the IOC’s subnet
::<code>$ '''telnet s100bcda 53127'''</code>

=== Disconnecting from an IOC’s shell ===

* '''Close the terminal''' that is connected to the screen or procServ session
** Disconnects from both screen & procServ
** Kills an IOC running outside of screen & procServ
* '''<code>Ctrl+a</code>''', '''<code>Ctrl+d</code>'''
** Disconnects from both screen & procServ
** Kills an IOC running outside of screen & procServ
* '''<code>Ctrl+a, d</code>'''
** Only disconnects from screen

=== IOC shell commands ===

See [https://wiki-ext.aps.anl.gov/blc/index.php?title=EPICS_Cheat_Sheet EPICS Cheat Sheet]

 
== Where does EPICS support reside at the APS ==
 
[[File:IOC_Support.jpg|center|thumb|500px]] 

== What's next? ==
For step by step instructions to create your own IOC, go to [https://git.aps.anl.gov/practical_beamline_controls_training/session_2/instructions IOC Deployment & Troubleshooting].

Beamline Controls

2023-06-13T18:57:28Z

Jemian: /* Beamline Data Pipelines */

WIKI for the APS Beamline Controls Community, maintained by the Beamline Controls Technical Working Group. 
This wiki exists to collect the output of the working group, including documentation on beamline controls software and hardware useful for APS beamline scientists and resident users.

----

===Beamline Controls Documentation===

* [[EPICS_Cheat_Sheet|EPICS Cheat Sheet]]: Channel Access command-lines, noteworthy record fields & IOC shell commands.
* [[EPICS_101|EPICS 101]]: definition of basic EPICS components ([https://wiki-ext.aps.anl.gov/blc/index.php?title=EPICS_101#What_is_an_IOC.3F IOC], [https://wiki-ext.aps.anl.gov/blc/index.php?title=EPICS_101#What_is_a_PV.3F PV], [https://wiki-ext.aps.anl.gov/blc/index.php?title=EPICS_101#What_is_a_record.3F record], [https://wiki-ext.aps.anl.gov/blc/index.php?title=EPICS_101#What_is_a_databases.3F database]).
* [[IOC_101|IOC 101]]: learn how to create your own IOC.
* [[Controls Software Documentation]]
* [[Hardware and IT Configuration]]

===Practical Beamline Controls Training (2023)===

[[Practical_Beamline_Controls_Training#IOC_Basics|Session 1: IOC Basics]]

[[Practical_Beamline_Controls_Training#IOC_Deployment_.26_Troubleshooting|Session 2: IOC Deployment & Troubleshooting]]

===Beamline Controls Technical Working Group information===

The BC Technical Working (BCTWG) group meets monthly to review and gather feedback on possible changes in either the way BC delivers support or the technologies that BC supports. The BCTWG comprises the BC group plus interested stakeholders from XSD. In a nutshell, the main goal of the BCTWG is to improve communication between BC and its customers on topics of mutual interest.

* Box folder with slides and meeting notes (ANL only): [https://anl.box.com/s/chcn7xauil93inay8ipinbxtcckc9k9f]

* Current chairs:
** Kevin Peterson (XSD-BC)
** Tejas Guruswamy (XSD-DET)
** Andrew Chuang (XSD-MPE)

===Beamline Data Pipelines===

* https://git.aps.anl.gov/groups/bdp-public/-/wikis/home

Beamline Controls

2023-06-06T18:28:42Z

Jemian: add BDP project link

WIKI for the APS Beamline Controls Community, maintained by the Beamline Controls Technical Working Group. 
This wiki exists to collect the output of the working group, including documentation on beamline controls software and hardware useful for APS beamline scientists and resident users.

----

===Beamline Controls Documentation===

* [[EPICS_Cheat_Sheet|EPICS Cheat Sheet]]: Channel Access command-lines, noteworthy record fields & IOC shell commands.
* [[EPICS_101|EPICS 101]]: definition of basic EPICS components ([https://wiki-ext.aps.anl.gov/blc/index.php?title=EPICS_101#What_is_an_IOC.3F IOC], [https://wiki-ext.aps.anl.gov/blc/index.php?title=EPICS_101#What_is_a_PV.3F PV], [https://wiki-ext.aps.anl.gov/blc/index.php?title=EPICS_101#What_is_a_record.3F record], [https://wiki-ext.aps.anl.gov/blc/index.php?title=EPICS_101#What_is_a_databases.3F database]).
* [[IOC_101|IOC 101]]: learn how to create your own IOC.
* [[Controls Software Documentation]]
* [[Hardware and IT Configuration]]

===Practical Beamline Controls Training (2023)===

[[Practical_Beamline_Controls_Training#IOC_Basics|Session 1: IOC Basics]]

[[Practical_Beamline_Controls_Training#IOC_Deployment_.26_Troubleshooting|Session 2: IOC Deployment & Troubleshooting]]

===Beamline Controls Technical Working Group information===

The BC Technical Working (BCTWG) group meets monthly to review and gather feedback on possible changes in either the way BC delivers support or the technologies that BC supports. The BCTWG comprises the BC group plus interested stakeholders from XSD. In a nutshell, the main goal of the BCTWG is to improve communication between BC and its customers on topics of mutual interest.

* Box folder with slides and meeting notes (ANL only): [https://anl.box.com/s/chcn7xauil93inay8ipinbxtcckc9k9f]

* Current chairs:
** Kevin Peterson (XSD-BC)
** Tejas Guruswamy (XSD-DET)
** Andrew Chuang (XSD-MPE)

===Beamline Data Pipelines===

* https://git.aps.anl.gov/BDP-Project/documentation/-/wikis/Overview

Controls Software Documentation

2022-12-08T21:30:19Z

Jemian: docker IOCs and training VM

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 [https://epics-controls.org/resources-and-support/documents/training/ resources from past EPICS Collaboration meetings].

==EPICS Base==
* [https://docs.epics-controls.org/en/latest/guides/EPICS_Intro.html Intro to EPICS]
* [https://docs.epics-controls.org/en/latest/guides/EPICS_Process_Database_Concepts.html EPICS Database Concepts]
* [https://docs.epics-controls.org/projects/how-tos/en/latest/getting-started/installation.html EPICS Base Getting Started (official)]
* [https://cmd-response.readthedocs.io/en/latest/epics/rpi_epics.html Installing EPICS on RaspberryPi]

==synApps (aka EPICS Support)==
* [https://epics.anl.gov/bcda/synApps/synApps_docs_all.html synApps Collected Documentation]
* [https://epics.anl.gov/bcda/synApps/synApps.html synApps deployment instructions, including use of xxx template ioc]

==areaDetector==
* [https://areadetector.github.io/master/index.html areaDetector Official Documentation]

==Deploying, troubleshooting, and maintaining IOCs==
* [[Troubleshooting EPICS IOCs]]
* [https://docs2bm.readthedocs.io/en/latest/source/ops/item_000_0.html simDetector Install directions (2BM)]
* [https://epics-modules.github.io/xxx/overview.html The Basics of an IOC (XXX documentation)]
* [https://gist.github.com/keenanlang/e768774cbd0a367b96281939b8a2c9ba Creation of an IOC using mkioc]
* [https://wiki.aps.anl.gov/bcda/index.php/Category:TUTORIAL BCDA Tutorials (APS Internal)]

==Pre-built IOCs==
===Docker images===
* EPICS Base 7.0.5, synApps 6.2: [https://github.com/prjemian/epics-docker/tree/main/v1.1/n3_synApps#readmemd standard xxx], [https://github.com/prjemian/epics-docker/tree/main/v1.1/n5_custom_synApps#readmemd customized]
* EPICS Base 7.0.5, synApps 6.2, area detector 3.10: [https://github.com/prjemian/epics-docker/tree/main/v1.1/n4_areaDetector#readmemd standard], [https://github.com/prjemian/epics-docker/tree/main/v1.1/n6_custom_areaDetector#readmemd custom]
===Virtual Machines===
* [https://github.com/BCDA-APS/epics-bluesky-vm/blob/main/install_vm.md APS Bluesky 101 training VM image.]

==Maintaining Documentation==
* [https://bctwg.readthedocs.io/en/latest/index.html ReadTheDocs tutorial and example site]

==APS ESAF & Proposal - Read-only interface==
* [https://bcda-aps.github.io/apsbss/ apsbss - Read-only interface to information from APS Proposal and ESAF (experiment safety approval form) databases.]

==Bluesky==
* [https://blueskyproject.io Bluesky home page]
* [https://try.nsls2.bnl.gov Try Bluesky in a web browser (from NSLS-II)]
* [https://bcda-aps.github.io/apstools apstools - Various Python tools for use with Bluesky at the APS.], [https://bcda-aps.github.io/apstools/examples/index.html Guides, How-Tos, and other examples.] [https://github.com/BCDA-APS/bluesky_training/blob/main/APS_Bluesky_101.md APS Bluesky 101 (from 2021).]
* [https://blueskyproject.io/hklpy/ hklpy: Bluesky's diffractometer support], [https://blueskyproject.io/hklpy/examples/index.html Diffractometer examples.]
* [https://github.com/BCDA-APS/bluesky_training Bluesky training for APS users]
* [https://github.com/BCDA-APS/bluesky_training/tree/main/bluesky Template for new instrument description. (Includes configuration for IPython console, Jupyter notebook, and bluesky-queueserver.]
* [https://github.com/BCDA-APS/use_bluesky#use_bluesky Installation Steps for APS users]
* [https://blueskyproject.io/bluesky-queueserver/ queueserver - Server for queueing plans.], [https://blueskyproject.io/bluesky-queueserver-api/ API documentation]
* [https://blueskyproject.io/tiled/ 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://slaclab.github.io/pydm/ PyDM - Python Display Manager]
* [https://github.com/BCDA-APS/adl2pydm adl2pydm - Convert MEDM's .adl files to PyDM's .ui format.]

==Python support==
===Channel Access===
* [https://pyepics.github.io/pyepics/ PyEpics - Python interface for Channel Access based on libca and libCom.]
* [https://caproto.github.io/caproto/v0.8.1/ caproto - Python interface for Channel Access in pure Python.]
===PV Access===
* [https://mdavidsaver.github.io/p4p/ p4p - Python interface for PV Access]
* [https://github.com/epics-base/pvaPy pvapy - Python interface for PV Access, also provides CA interface]
===General===
* [https://bcdamenu.readthedocs.io/ bcdamenu - GUI menu to beam line software, such as synoptic display.]
* [https://github.com/EPICS-synApps/support/tree/master/utils/mdaPythonUtils mdaPythonUtils - Read .mda data files into Python.]
* [https://github.com/prjemian/pvMail PvMail - Watch an EPICS PV. Send email when it changes from 0 to 1.]
* [https://github.com/BCDA-APS/pvview pvView - Display one or more EPICS PVs in a PyDM GUI window as a table.]
* [https://github.com/BCDA-APS/pvWebMonitor pvWebMonitor - Post EPICS PVs to read-only (static) web site.]
* [https://prjemian.github.io/punx/ punx - Python Utilities for NeXus HDF5 files: validation, structure, hierarchy.]
* [https://prjemian.github.io/pyRestTable/ pyRestTable - Format a nice table in reST (reStructuredText) from Python.]
* [https://prjemian.github.io/pysumreg/ pysumreg - Statistics of list of (x,y) pairs from calculator-style summation registers.]
* [https://github.com/prjemian/spec2nexus/ spec2nexus - Read SPEC data files into Python, write NeXus data file.]

Controls Software Documentation

2022-12-08T21:18:28Z

Jemian: /* EPICS Base */ Installing EPICS on RaspberryPi

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 [https://epics-controls.org/resources-and-support/documents/training/ resources from past EPICS Collaboration meetings].

==EPICS Base==
* [https://docs.epics-controls.org/en/latest/guides/EPICS_Intro.html Intro to EPICS]
* [https://docs.epics-controls.org/en/latest/guides/EPICS_Process_Database_Concepts.html EPICS Database Concepts]
* [https://docs.epics-controls.org/projects/how-tos/en/latest/getting-started/installation.html EPICS Base Getting Started (official)]
* [https://cmd-response.readthedocs.io/en/latest/epics/rpi_epics.html Installing EPICS on RaspberryPi]

==synApps (aka EPICS Support)==
* [https://epics.anl.gov/bcda/synApps/synApps_docs_all.html synApps Collected Documentation]
* [https://epics.anl.gov/bcda/synApps/synApps.html synApps deployment instructions, including use of xxx template ioc]

==areaDetector==
* [https://areadetector.github.io/master/index.html areaDetector Official Documentation]

==Deploying, troubleshooting, and maintaining IOCs==
* [[Troubleshooting EPICS IOCs]]
* [https://docs2bm.readthedocs.io/en/latest/source/ops/item_000_0.html simDetector Install directions (2BM)]
* [https://epics-modules.github.io/xxx/overview.html The Basics of an IOC (XXX documentation)]
* [https://gist.github.com/keenanlang/e768774cbd0a367b96281939b8a2c9ba Creation of an IOC using mkioc]
* [https://wiki.aps.anl.gov/bcda/index.php/Category:TUTORIAL BCDA Tutorials (APS Internal)]
==Maintaining Documentation==
* [https://bctwg.readthedocs.io/en/latest/index.html ReadTheDocs tutorial and example site]

==APS ESAF & Proposal - Read-only interface==
* [https://bcda-aps.github.io/apsbss/ apsbss - Read-only interface to information from APS Proposal and ESAF (experiment safety approval form) databases.]

==Bluesky==
* [https://blueskyproject.io Bluesky home page]
* [https://try.nsls2.bnl.gov Try Bluesky in a web browser (from NSLS-II)]
* [https://bcda-aps.github.io/apstools apstools - Various Python tools for use with Bluesky at the APS.], [https://bcda-aps.github.io/apstools/examples/index.html Guides, How-Tos, and other examples.]
* [https://blueskyproject.io/hklpy/ hklpy: Bluesky's diffractometer support], [https://blueskyproject.io/hklpy/examples/index.html Diffractometer examples.]
* [https://github.com/BCDA-APS/bluesky_training Bluesky training for APS users]
* [https://github.com/BCDA-APS/bluesky_training/tree/main/bluesky Template for new instrument description. (Includes configuration for IPython console, Jupyter notebook, and bluesky-queueserver.]
* [https://github.com/BCDA-APS/use_bluesky#use_bluesky Installation Steps for APS users]
* [https://blueskyproject.io/bluesky-queueserver/ queueserver - Server for queueing plans.], [https://blueskyproject.io/bluesky-queueserver-api/ API documentation]
* [https://blueskyproject.io/tiled/ 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://slaclab.github.io/pydm/ PyDM - Python Display Manager]
* [https://github.com/BCDA-APS/adl2pydm adl2pydm - Convert MEDM's .adl files to PyDM's .ui format.]

==Python support==
===Channel Access===
* [https://pyepics.github.io/pyepics/ PyEpics - Python interface for Channel Access based on libca and libCom.]
* [https://caproto.github.io/caproto/v0.8.1/ caproto - Python interface for Channel Access in pure Python.]
===PV Access===
* [https://mdavidsaver.github.io/p4p/ p4p - Python interface for PV Access]
* [https://github.com/epics-base/pvaPy pvapy - Python interface for PV Access, also provides CA interface]
===General===
* [https://bcdamenu.readthedocs.io/ bcdamenu - GUI menu to beam line software, such as synoptic display.]
* [https://github.com/EPICS-synApps/support/tree/master/utils/mdaPythonUtils mdaPythonUtils - Read .mda data files into Python.]
* [https://github.com/prjemian/pvMail PvMail - Watch an EPICS PV. Send email when it changes from 0 to 1.]
* [https://github.com/BCDA-APS/pvview pvView - Display one or more EPICS PVs in a PyDM GUI window as a table.]
* [https://github.com/BCDA-APS/pvWebMonitor pvWebMonitor - Post EPICS PVs to read-only (static) web site.]
* [https://prjemian.github.io/punx/ punx - Python Utilities for NeXus HDF5 files: validation, structure, hierarchy.]
* [https://prjemian.github.io/pyRestTable/ pyRestTable - Format a nice table in reST (reStructuredText) from Python.]
* [https://prjemian.github.io/pysumreg/ pysumreg - Statistics of list of (x,y) pairs from calculator-style summation registers.]
* [https://github.com/prjemian/spec2nexus/ spec2nexus - Read SPEC data files into Python, write NeXus data file.]

Controls Software Documentation

2022-12-08T21:17:36Z

Jemian: /* General */ bcdamenu

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 [https://epics-controls.org/resources-and-support/documents/training/ resources from past EPICS Collaboration meetings].

==EPICS Base==
* [https://docs.epics-controls.org/en/latest/guides/EPICS_Intro.html Intro to EPICS]
* [https://docs.epics-controls.org/en/latest/guides/EPICS_Process_Database_Concepts.html EPICS Database Concepts]
* [https://docs.epics-controls.org/projects/how-tos/en/latest/getting-started/installation.html EPICS Base Getting Started (official)]

==synApps (aka EPICS Support)==
* [https://epics.anl.gov/bcda/synApps/synApps_docs_all.html synApps Collected Documentation]
* [https://epics.anl.gov/bcda/synApps/synApps.html synApps deployment instructions, including use of xxx template ioc]

==areaDetector==
* [https://areadetector.github.io/master/index.html areaDetector Official Documentation]

==Deploying, troubleshooting, and maintaining IOCs==
* [[Troubleshooting EPICS IOCs]]
* [https://docs2bm.readthedocs.io/en/latest/source/ops/item_000_0.html simDetector Install directions (2BM)]
* [https://epics-modules.github.io/xxx/overview.html The Basics of an IOC (XXX documentation)]
* [https://gist.github.com/keenanlang/e768774cbd0a367b96281939b8a2c9ba Creation of an IOC using mkioc]
* [https://wiki.aps.anl.gov/bcda/index.php/Category:TUTORIAL BCDA Tutorials (APS Internal)]
==Maintaining Documentation==
* [https://bctwg.readthedocs.io/en/latest/index.html ReadTheDocs tutorial and example site]

==APS ESAF & Proposal - Read-only interface==
* [https://bcda-aps.github.io/apsbss/ apsbss - Read-only interface to information from APS Proposal and ESAF (experiment safety approval form) databases.]

==Bluesky==
* [https://blueskyproject.io Bluesky home page]
* [https://try.nsls2.bnl.gov Try Bluesky in a web browser (from NSLS-II)]
* [https://bcda-aps.github.io/apstools apstools - Various Python tools for use with Bluesky at the APS.], [https://bcda-aps.github.io/apstools/examples/index.html Guides, How-Tos, and other examples.]
* [https://blueskyproject.io/hklpy/ hklpy: Bluesky's diffractometer support], [https://blueskyproject.io/hklpy/examples/index.html Diffractometer examples.]
* [https://github.com/BCDA-APS/bluesky_training Bluesky training for APS users]
* [https://github.com/BCDA-APS/bluesky_training/tree/main/bluesky Template for new instrument description. (Includes configuration for IPython console, Jupyter notebook, and bluesky-queueserver.]
* [https://github.com/BCDA-APS/use_bluesky#use_bluesky Installation Steps for APS users]
* [https://blueskyproject.io/bluesky-queueserver/ queueserver - Server for queueing plans.], [https://blueskyproject.io/bluesky-queueserver-api/ API documentation]
* [https://blueskyproject.io/tiled/ 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://slaclab.github.io/pydm/ PyDM - Python Display Manager]
* [https://github.com/BCDA-APS/adl2pydm adl2pydm - Convert MEDM's .adl files to PyDM's .ui format.]

==Python support==
===Channel Access===
* [https://pyepics.github.io/pyepics/ PyEpics - Python interface for Channel Access based on libca and libCom.]
* [https://caproto.github.io/caproto/v0.8.1/ caproto - Python interface for Channel Access in pure Python.]
===PV Access===
* [https://mdavidsaver.github.io/p4p/ p4p - Python interface for PV Access]
* [https://github.com/epics-base/pvaPy pvapy - Python interface for PV Access, also provides CA interface]
===General===
* [https://bcdamenu.readthedocs.io/ bcdamenu - GUI menu to beam line software, such as synoptic display.]
* [https://github.com/EPICS-synApps/support/tree/master/utils/mdaPythonUtils mdaPythonUtils - Read .mda data files into Python.]
* [https://github.com/prjemian/pvMail PvMail - Watch an EPICS PV. Send email when it changes from 0 to 1.]
* [https://github.com/BCDA-APS/pvview pvView - Display one or more EPICS PVs in a PyDM GUI window as a table.]
* [https://github.com/BCDA-APS/pvWebMonitor pvWebMonitor - Post EPICS PVs to read-only (static) web site.]
* [https://prjemian.github.io/punx/ punx - Python Utilities for NeXus HDF5 files: validation, structure, hierarchy.]
* [https://prjemian.github.io/pyRestTable/ pyRestTable - Format a nice table in reST (reStructuredText) from Python.]
* [https://prjemian.github.io/pysumreg/ pysumreg - Statistics of list of (x,y) pairs from calculator-style summation registers.]
* [https://github.com/prjemian/spec2nexus/ spec2nexus - Read SPEC data files into Python, write NeXus data file.]

Controls Software Documentation

2022-12-08T21:17:05Z

Jemian: /* Python support */

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 [https://epics-controls.org/resources-and-support/documents/training/ resources from past EPICS Collaboration meetings].

==EPICS Base==
* [https://docs.epics-controls.org/en/latest/guides/EPICS_Intro.html Intro to EPICS]
* [https://docs.epics-controls.org/en/latest/guides/EPICS_Process_Database_Concepts.html EPICS Database Concepts]
* [https://docs.epics-controls.org/projects/how-tos/en/latest/getting-started/installation.html EPICS Base Getting Started (official)]

==synApps (aka EPICS Support)==
* [https://epics.anl.gov/bcda/synApps/synApps_docs_all.html synApps Collected Documentation]
* [https://epics.anl.gov/bcda/synApps/synApps.html synApps deployment instructions, including use of xxx template ioc]

==areaDetector==
* [https://areadetector.github.io/master/index.html areaDetector Official Documentation]

==Deploying, troubleshooting, and maintaining IOCs==
* [[Troubleshooting EPICS IOCs]]
* [https://docs2bm.readthedocs.io/en/latest/source/ops/item_000_0.html simDetector Install directions (2BM)]
* [https://epics-modules.github.io/xxx/overview.html The Basics of an IOC (XXX documentation)]
* [https://gist.github.com/keenanlang/e768774cbd0a367b96281939b8a2c9ba Creation of an IOC using mkioc]
* [https://wiki.aps.anl.gov/bcda/index.php/Category:TUTORIAL BCDA Tutorials (APS Internal)]
==Maintaining Documentation==
* [https://bctwg.readthedocs.io/en/latest/index.html ReadTheDocs tutorial and example site]

==APS ESAF & Proposal - Read-only interface==
* [https://bcda-aps.github.io/apsbss/ apsbss - Read-only interface to information from APS Proposal and ESAF (experiment safety approval form) databases.]

==Bluesky==
* [https://blueskyproject.io Bluesky home page]
* [https://try.nsls2.bnl.gov Try Bluesky in a web browser (from NSLS-II)]
* [https://bcda-aps.github.io/apstools apstools - Various Python tools for use with Bluesky at the APS.], [https://bcda-aps.github.io/apstools/examples/index.html Guides, How-Tos, and other examples.]
* [https://blueskyproject.io/hklpy/ hklpy: Bluesky's diffractometer support], [https://blueskyproject.io/hklpy/examples/index.html Diffractometer examples.]
* [https://github.com/BCDA-APS/bluesky_training Bluesky training for APS users]
* [https://github.com/BCDA-APS/bluesky_training/tree/main/bluesky Template for new instrument description. (Includes configuration for IPython console, Jupyter notebook, and bluesky-queueserver.]
* [https://github.com/BCDA-APS/use_bluesky#use_bluesky Installation Steps for APS users]
* [https://blueskyproject.io/bluesky-queueserver/ queueserver - Server for queueing plans.], [https://blueskyproject.io/bluesky-queueserver-api/ API documentation]
* [https://blueskyproject.io/tiled/ 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://slaclab.github.io/pydm/ PyDM - Python Display Manager]
* [https://github.com/BCDA-APS/adl2pydm adl2pydm - Convert MEDM's .adl files to PyDM's .ui format.]

==Python support==
===Channel Access===
* [https://pyepics.github.io/pyepics/ PyEpics - Python interface for Channel Access based on libca and libCom.]
* [https://caproto.github.io/caproto/v0.8.1/ caproto - Python interface for Channel Access in pure Python.]
===PV Access===
* [https://mdavidsaver.github.io/p4p/ p4p - Python interface for PV Access]
* [https://github.com/epics-base/pvaPy pvapy - Python interface for PV Access, also provides CA interface]
===General===
* [https://bcdamenu.readthedocs.io/ - GUI menu to beam line software, such as synoptic display.]
* [https://github.com/EPICS-synApps/support/tree/master/utils/mdaPythonUtils mdaPythonUtils - Read .mda data files into Python.]
* [https://github.com/prjemian/pvMail PvMail - Watch an EPICS PV. Send email when it changes from 0 to 1.]
* [https://github.com/BCDA-APS/pvview pvView - Display one or more EPICS PVs in a PyDM GUI window as a table.]
* [https://github.com/BCDA-APS/pvWebMonitor pvWebMonitor - Post EPICS PVs to read-only (static) web site.]
* [https://prjemian.github.io/punx/ punx - Python Utilities for NeXus HDF5 files: validation, structure, hierarchy.]
* [https://prjemian.github.io/pyRestTable/ pyRestTable - Format a nice table in reST (reStructuredText) from Python.]
* [https://prjemian.github.io/pysumreg/ pysumreg - Statistics of list of (x,y) pairs from calculator-style summation registers.]
* [https://github.com/prjemian/spec2nexus/ spec2nexus - Read SPEC data files into Python, write NeXus data file.]

Controls Software Documentation

2022-12-08T21:06:36Z

Jemian: /* Bluesky */

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 [https://epics-controls.org/resources-and-support/documents/training/ resources from past EPICS Collaboration meetings].

==EPICS Base==
* [https://docs.epics-controls.org/en/latest/guides/EPICS_Intro.html Intro to EPICS]
* [https://docs.epics-controls.org/en/latest/guides/EPICS_Process_Database_Concepts.html EPICS Database Concepts]
* [https://docs.epics-controls.org/projects/how-tos/en/latest/getting-started/installation.html EPICS Base Getting Started (official)]

==synApps (aka EPICS Support)==
* [https://epics.anl.gov/bcda/synApps/synApps_docs_all.html synApps Collected Documentation]
* [https://epics.anl.gov/bcda/synApps/synApps.html synApps deployment instructions, including use of xxx template ioc]

==areaDetector==
* [https://areadetector.github.io/master/index.html areaDetector Official Documentation]

==Deploying, troubleshooting, and maintaining IOCs==
* [[Troubleshooting EPICS IOCs]]
* [https://docs2bm.readthedocs.io/en/latest/source/ops/item_000_0.html simDetector Install directions (2BM)]
* [https://epics-modules.github.io/xxx/overview.html The Basics of an IOC (XXX documentation)]
* [https://gist.github.com/keenanlang/e768774cbd0a367b96281939b8a2c9ba Creation of an IOC using mkioc]
* [https://wiki.aps.anl.gov/bcda/index.php/Category:TUTORIAL BCDA Tutorials (APS Internal)]
==Maintaining Documentation==
* [https://bctwg.readthedocs.io/en/latest/index.html ReadTheDocs tutorial and example site]

==APS ESAF & Proposal - Read-only interface==
* [https://bcda-aps.github.io/apsbss/ apsbss - Read-only interface to information from APS Proposal and ESAF (experiment safety approval form) databases.]

==Bluesky==
* [https://blueskyproject.io Bluesky home page]
* [https://try.nsls2.bnl.gov Try Bluesky in a web browser (from NSLS-II)]
* [https://bcda-aps.github.io/apstools apstools - Various Python tools for use with Bluesky at the APS.], [https://bcda-aps.github.io/apstools/examples/index.html Guides, How-Tos, and other examples.]
* [https://blueskyproject.io/hklpy/ hklpy: Bluesky's diffractometer support], [https://blueskyproject.io/hklpy/examples/index.html Diffractometer examples.]
* [https://github.com/BCDA-APS/bluesky_training Bluesky training for APS users]
* [https://github.com/BCDA-APS/bluesky_training/tree/main/bluesky Template for new instrument description. (Includes configuration for IPython console, Jupyter notebook, and bluesky-queueserver.]
* [https://github.com/BCDA-APS/use_bluesky#use_bluesky Installation Steps for APS users]
* [https://blueskyproject.io/bluesky-queueserver/ queueserver - Server for queueing plans.], [https://blueskyproject.io/bluesky-queueserver-api/ API documentation]
* [https://blueskyproject.io/tiled/ 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://slaclab.github.io/pydm/ PyDM - Python Display Manager]
* [https://github.com/BCDA-APS/adl2pydm adl2pydm - Convert MEDM's .adl files to PyDM's .ui format.]

==Python support==
* [https://pyepics.github.io/pyepics/ PyEpics - Python interface for Channel Access based on libca and libCom.]
* [https://caproto.github.io/caproto/v0.8.1/ caproto - Python interface for Channel Access in pure Python.]
* [https://mdavidsaver.github.io/p4p/ p4p - Python interface for PV Access]
* [https://github.com/epics-base/pvaPy pvapy - Python interface for PV Access]
* [https://github.com/EPICS-synApps/support/tree/master/utils/mdaPythonUtils mdaPythonUtils - Read .mda data files into Python.]
* [https://github.com/prjemian/pvMail PvMail - Watch an EPICS PV. Send email when it changes from 0 to 1.]
* [https://github.com/BCDA-APS/pvWebMonitor pvWebMonitor - Post EPICS PVs to read-only (static) web site.]
* [https://prjemian.github.io/punx/ punx - Python Utilities for NeXus HDF5 files: validation, structure, hierarchy.]
* [https://prjemian.github.io/pyRestTable/ pyRestTable - Format a nice table in reST (reStructuredText) from Python.]
* [https://github.com/prjemian/spec2nexus/ spec2nexus - Read SPEC data files into Python, write NeXus data file.]

Controls Software Documentation

2022-12-08T21:02:07Z

Jemian: /* Bluesky */ PyDM

Controls Software Documentation

2022-12-08T21:00:34Z

Jemian: /* Python support */

Controls Software Documentation

2022-12-08T20:54:38Z

Jemian: /* Bluesky */

Controls Software Documentation

2022-12-08T20:52:57Z

Jemian: /* Bluesky */

Controls Software Documentation

2022-12-08T20:49:54Z

Jemian: /* Python support */

Controls Software Documentation

2022-12-08T20:49:25Z

Jemian: /* Python client support */

Controls Software Documentation

2022-12-08T20:49:03Z

Jemian: EPICS client support in Python

Controls Software Documentation

2022-12-08T20:34:56Z

Jemian: /* Bluesky */

Controls Software Documentation

2022-12-08T20:31:26Z

Jemian: /* APS ESAF & Proposal */

Controls Software Documentation

2022-12-08T20:30:52Z

Jemian: add bluesky content