Accelerator Physics Software Work Tracking
Priorities 1,2,3 are high/medium/low respectively
Major Upgrades & Projects
Task | Application/area | Person(s) Responsible | Status | Priority | Notes | GitHub/CATER/etc |
---|---|---|---|---|---|---|
| Global | S2E group + Buschmann + more | WIP | 1 | Lattice files for Brad already exist. Current high-level goals are:
| |
| Global | Cesar, Perez, Buschmann | WIP | 1 |
| https://github.com/slaclab/facet-matlabTNG/pull/3 |
| LEM | Buschmann | 2 |
| ||
| Optics Matching | Perez | 3 | last step needed to migrate off of the LCLS-side emittance application. seems to be already partially implemented, so the challenge here is partially archeological in nature. | ||
| BSA | Buschmann | WIP | 2 |
| |
| Phase Scans | Buschmann | DONE | 2 | rudimentary functionality, needs with-beam test update 05/06/24: tested with beam L0, L1 and L2-3 are working, deployment soon... | https://github.com/slaclab/facet-matlabTNG/pull/4 |
Maintenance & Technical Debt
Issue | Application/area | Person(s) Responsible | Status | Priority | Notes | GitHub/CATER/etc |
---|---|---|---|---|---|---|
| Feedbacks | Buschmann | WIP | 1 | MD plan for debugging is ready to go | 166749 |
| Optics | Buschmann | 2 | 166714 | ||
| LEM | Buschmann | 2 | 166618 | ||
| Schottky Scan | Loney | WIP | 3 | Option to use laser timing, fix plotting issues, various other bugs | 158479 (ish) |
| Global | Buschmann | done | 2 | managed to launch server, but haven't figured out how to launch GUIs yet update 4/24: done. added a button to launch from the ops dashboard – only a few OPIs supported at the moment, but adding support from new machines isn't hard | |
| S20 Config | Buschmann | Done | 3 | ||
| Sextupole | Buschmann | done | 3 | ancient CATER - maybe not an issue anymore? needs discussion update 06/2024: real issue, fixed now! | 117540 |
| Schottky Scan | Perez | Done | 3 | changed to [ -50 10 ] | |
| Feedbacks | Buschmann | Done | 3 | trivial fix | 157790 |
| Schottky Scan | Loney | done | 3 | (should be) trivial fix, also change default range and add gun offset | 167704 |
Minor Upgrades & Projects
Issue | Application/area | Person(s) Responsible | Status | Priority | Notes | GitHub/CATER/etc |
---|---|---|---|---|---|---|
| LAME | Parker | WIP | 3 | ||
| Global | Perez | WIP | 3 | F2_Feedbacks does this already with a hardcoded list, something similar could be done in other GUIs than have a lot of anonymous matlab PVs – ideally this could be automated by parsing the GUIs internal list of PVs | |
| Buschmann/Parker | WIP | 2 | Camera is serving stats. Just need a way to measure a conversion factor of MeV/pixel, then write both the calibration and the sigmaE to matlab PVC
| ||
| Kalsi | WIP | 1 | |||
| Buschmann | 3 | I'm imagining a script that gets 10571 + 10711 + SYAG + DTOTR2 images, and logbooks the most recent set of emittance/S20 measurements | |||
| Loney | WIP | 1 |
| ||
| wirescans | Buschmann | 3 | |||
| Loney | WIP | 3 | |||
| TCAV GUI | |||||
| Global | Buschmann | done | 3 | nice | |
| CUDs | Buschmann | done | 3 | update 2/28/24: infrastructure exists to set new references remotely and update CUDs remotely, but the callbacks for each type of reference data are not complete – i.e. need to save DTOTR2 to a PNG, so CUDs can display, or save BPM data to a .mat etc etc | |
| BSA | Perez | Done | 2 | ||
| Wire/Multi-Wire | Buschmann (+intrepid sidekick?) | Done | 1 | Both wire GUIs use the F2_WirescanApp object – save fit data/timestamps etc there, then GUIs can log & display that info as needed
| |
| F2 CUDs | Buschmann | done | 3 | update 4/9/24: working on updates to this display 5/24: done, v2 released | |
Standby Tasks / Wishlist / Brainstorm
Generic/Global
- Remove remaining dependencies on legacy Matlab2012 & "matlab model" code
- Remove instances of direct use of LabCA - move everything over to using PV class in readiness for implementation of PVA
- Beam stay clear plot vs Z (beam aperture vs Z, or acceptance vs delta E)
- Automation/tools to facilitate 7-hole alignment
- Injector RF waveform generator tool
- MPS interlocking for EOS
- Klystron jitter report
LEM
- write L1-L3 design phases to PVs
- ignore CQs/SQs when propagating twins parameters. (BMAG plot)
- flag "matching quads" and handle separately when "Lem to model"
- fix BACT=0 causing NaNs in BMAG propagation
Orbit
- indicate TRIM operation in progress by disabling UI
- Orbit fitting tools
- Allow reference orbits to have names changed in Python Orbit Display Reference Orbit list
Optics
- wire names don't update in multiwire matching tabs after changing linac selection
- automatically de-select CQ/SQs from matching options
- native quad scans → ultimate goal of fully migrating off of the LCLS emittance GUI
Feedbacks
- tie DL10 set point directly to LLRF control (switch off "slow FB" on RF controller when FB on and vice-versa, increase gain)
- Implement full PID controller coefficients to each feedback, setup and test and include P or PID as option (at least for DL10)
- Implement use of LI17 fast phase shifters for BC20 feedback through SCP multiknob controls
- Auto-adjust gains for changes in beam rate
- Add FFS transverse feedback
MDL Feedforward
Wirescans
- Wire scanner GUI not set wire speed to such a low speed after a scan that the following scan fails if you change planes for IPWS1.
S20 Config
Orphaned/Unknown Tasks
These are software tasks that are in an unknown state or not currently being worked
Task | Last Person Responsible | Status |
---|---|---|
Implement interface to SCP corr plots | George, Glen | 10/22/22: Implemented by George, documentation on AIDA-PVA website, needs testing |
Feedback HSTA bit control (be able to change Feedback → Compute) | George, Glen | 9/22/22: Implemented and tested ability to write raw HSTA bit values, matlab interface to toggle OFF, Compute, Feedback states written and tested. George to implement cleaner AIDA-level state change interface. |
Fix AIDA service crashes on VAX (or be able to detect and self correct) | George, Greg | 9/22/22: Many potential non catching of errors found by George and changes to server-side code made, cannot induce server failures by testing. Need to operationally observe to see if fixes are good. |
...
Software Development Workflow
All production software must be under some form of version control. In general: code with a larger audience of users or that is a significant dependency of downstream software should be managed more carefully.
Master repositories can be found here: /afs/slac/g/cd/swe/git/repos/slac/FACET/
"Production" HLAs live in a number of location, mainly $TOOLS/python
and $TOOLS/matlabTNG
These instructions are written assuming some preexisting knowledge of version control & some basic git knowledge. If you have questions ask Zack.
How to create a new repo
- navigate to the
/afs/
prod directory andmkdir <repo_name>.git
- run
git init --bare
to instantiate a new empty repo - (if using GitHub) make a new GitHub repo with the same name
- clone the master repo into a work directory (can be anywhere, /afs/-space, DMZ or prod):
git clone ssh:///afs/slac/g/cd/swe/git/repos/slac/FACET/<repo_name>.git
- do work, then
git commit
&git push
- (after implementation/deployment) clone the master repo into a production repository
Once you create a new repo or clone one, there are two workflows: one simple command-line only way to use git, or also using the SLAC GitHub to enable some more formal code review processes.
Repo mirroring with GitHub:
GitHub is hosted on the public internet. In order to store production software there, we need to use a "relay" repo that lives on the DMZ network to facilitate pushing/pulling changes between GitHub and the local repo on the SLAC network.
- ssh to
centos7
, navigate to/u/gu/zack/github_relay/
- run
python relay_setup.py <prod_repo_name> <github_repo_name>
to setup a "relay repository" used to sync /afs/ and GitHub. This script will:git clone
the repo into thegithub_relay
directorygit remote add github git@github.com:slaclab/<github_repo_name>.git
- add
<repo_name>
to/u/gu/zack/github_relay/tracked_repos.txt
Direct push to master (for minor changes or lower-impact software):
- from your work directory:
git commit
,git push origin master
- from the production directory, and
git pull origin master
Feature-branches with GitHub (for major changes or high-impact software):
This process will be automated in future, but for now relies manually using the script: /u/gu/zack/github_relay/sync_github.py
- Setup relay mirroring to GitHub as described above
- from your work directory for the repo in question, make a new branch:
git branch <branch_name>
- make changes, commit them to
<branch_name>
and push the branch to/afs/
- use
sync_github.py
to push the branch to GitHub - open a pull request, assign reviewers, review code & merge to master
- use
sync_github.py
to pull the updated master branch from GitHub back to/afs/
- deploy to production
To deploy software to production
- run
git pull origin master
in the production repository
Using sync_github.py
- to sync prod → GitHub:
$ python sync_github.py push <repo name> <(optional) branch name>
- to sync GitHub → prod:
$ python sync_github.py pull <repo name> <(optional) branch name>
...
Legacy Task Tracking
These are the HLA tasks as they existed as of 01/2024. This content is archival.
Preferred development workflow with git repository:
- Create new development branch for work in personal clone of repo
- Do work and test
- Merge in any recent changes from main branch
- Push your branch, email Glen to evaluate & merge into main branch
Generic tasks/ideas
Task | Status | Assigned By | Actively Worked on by... |
---|---|---|---|
Full lists of PVs used in HLAs accessible from each help menu | Glen | Sharon | |
Complete documentation for each HLA & generic controls/modeling interface | Glen | ||
Remove remaining dependencies on legacy Matlab2012 & "matlab model" code | Glen | ||
Remove instances of direct use of LabCA - move everything over to using PV class in readiness for implementation of PVA | Needs doing by mid-2023? | Glen | |
Faster list-based caget operations in PV class + improve first-time calls (speed up LiveModel initialization) | Glen | ||
Implement asyn operations when move to >Matlab2021 | Glen | ||
Extend matlab server model to facet-srv01? | Glen | ||
Change default range of Schottky Scan GUI | Loney | Sharon | |
Automation of 10-3/10-4 phase scans (in Schottky GUI or phase scan GUI) | To be implemented into new phase scan GUI | Loney | Buschmann |
Add Logbook feature to BSA GUI | Loney | Sharon |
AIDA-PVA
Task | Status | Assigned by | Actively Worked on by... | |||
---|---|---|---|---|---|---|
Larger # buffered BPM data acquisitions (up to 1000 @ 10Hz?) | 11/7/22: Tested, deployed in Wirescan app- appears to be working well. | Glen | COMPLETE | |||
Asynchronous calls (especially for bufferedacq) from Matlab | 911/194/22: implemented in aida jar, new asyn code implemented in F2_bpms, awaiting server running for tests | Glen | George, Glen | Tested, declared working. | Glen | COMPLETE |
Implement interface to SCP corr plots | 10/22/22: Implemented by George, documentation on AIDA-PVA website, needs testing | Glen | George, | Ability to initiate fast phase dither scans and pull back buffered data + pulse ID's | Glen | |
Multi-device set (and asynchronous status return) on PMDL (and others...?) | Glen | Automate ENLD calculation from AIDA call (generic ability to initiate button macros?) | 11/7/22: Tested, working well in MDLFF app for multi-set of PMDL values. | Glen | COMPLETEGlen | |
Feedback HSTA bit control (be able to change Feedback → Compute) | Priority | 9/22/22: Implemented and tested ability to write raw HSTA bit values, matlab interface to toggle OFF, Compute, Feedback states written and tested. George to implement cleaner AIDA-level state change interface. | Glen | George, Glen | ||
Fix AIDA service crashes on VAX (or be able to detect and self correct)Priority | 9/22/22: Many potential non catching of errors found by George and changes to server-side code made, cannot induce server failures by testing. Need to operationally observe to see if fixes are good. | Glen | George & Greg |
F2_Orbit
Task | Status | Assigned By | Actively Worked on by... |
---|---|---|---|
Plotted orbit doesn't respect pre-selected BPM list when loading a Config with pre-measured BPM data | Glen | ||
Indicate TRIM operation in progress by grey-out of "Do correction" button or similar | Glen | ||
Make MIA tab functionality work | Glen | ||
"Plot all" option doesn't work correctly when displaying corrected orbit after performing orbit correction calc | Glen | ||
Re-instate some auto dispersion correct functionality (e.g. DL10 correction with Q10731) | Glen | ||
Add kick and dispersion source fit functionality to orbit and dispersion tabs | Glen | ||
Changing fit location should update plot and fit data- currently doesn't work | Glen | ||
Link reference orbit saved to Python bpm orbit tool reference saves | Glen | ||
Implement TMIT cuts for BPM orbit | Glen | ||
Implement measured Rmat (as opposed to model Rmat) interface (including measurement tools?) | Glen |
F2_LEM
Task | Status | Assigned By | Actively Worked on by... |
---|---|---|---|
Store design L1,L2,L3 operating phases in EPICS PVs | Glen | ||
Watcher version of LEM: info on when LEM needed etc + interface with CUD | Glen | ||
Ignore CQ's & SQ's for purposes of Twiss parameter propagation (BMAG plot) | Glen | ||
Make a way to flag "Matching Quads" and deal with them differently when "LEM to model"? | Glen | ||
Fix BACT=0 causing "NaN"'s in BMAG propogation | Glen | ||
Convert to server + watcher architecture | Buschmann | Buschmann |
F2_Matching
Task | Status | Assigned By | Actively Worked on by... |
---|---|---|---|
On Multi-Wire matching tabs, wire names don't change when reading in data from different Linac section | Glen | ||
Keep last vals in MW tab when switch back from other tab | Glen | ||
Auto de-select CQ & SQ magnets from matching options | Glen | ||
Add native quad scan functionality | Glen | ||
Allow Undo button to retain old values after calculating new match | Loney |
F2_Feedback
Task | Status | Assigned By | Actively Worked on by... |
---|---|---|---|
Jitter button ON/OFF status not working properly | Glen | ||
DL10 controller name "IN10"→"LI10" on GUI | Glen | ||
Settings GUI plot to include line showing feedback desired offset value | Glen | ||
Fix freezing of GUI when closing settings panels | Glen | ||
Tie DL10 feedback stpoint directly to LLRF control → switch off "slow fb" on RF controller when feedback on and vice-versa, increase feedback gain | Glen | ||
Implement full PID controller coefficients to each feedback, setup and test and include P or PID as option (at least for DL10) | Glen | ||
Implement use of LI17 fast phase shifters for BC20 feedback through SCP multiknob controls | Glen | ||
Auto-adjust gains for changes in beam rate | Glen | ||
Add FFS transverse feedback | Glen | Lauren | |
MDL_FeedForward
Task | Status | Assigned by | Actively Worked on by... |
---|---|---|---|
Data collection: have watcher record each GOLD entry and associated data and save to disk | Glen | ||
Make user-facing configuration GUI to examine training data & evaluate performance & tune NN or linear models or manually tweak | Glen | ||
Implement multi-device write commands in AIDA for PMDL data | 10/7/22: AIDA software written to allow this | Glen | COMPLETE |
F2_Wirescanner
Task | Status | Assigned by | Actively Worked on by... |
---|---|---|---|
User access to PMT timing & gate widths | Glen | ||
When selecting motor position units option- propagate changes to plot to see centroid of scan in motor units | Glen | ||
Jitter correction for Linac wirescanners in L2 and L3 | 9/19/22: Initial tests show buffered bpm acq with ~200 pulses works, initial code implemented, needs testing with beam | GlenGlen | COMPLETE |
S20 Configurator
Task | Status | Assigned by | Actively Worked on by... |
---|---|---|---|
Write current IP waist position to a dedicated PV instead of sharing with desired waist position | Ryan | Buschmann |
S20 IP Waist from BPM Jitter
Task | Status | Assigned by | Actively Worked on by... |
---|---|---|---|
Create | 11/6/22: Tested, working. Results are unstable, assuming this is due to dispersion leakage and large energy jitter. Next job is to implement SVD algorithm to simultaneously fit dispersion functions and remove energy jitter component. | Glen | Glen |
SLC Control System Notes
Ken Brobeck's How to restart some VMS processes guide.