Accelerator Physics Software Work Tracking

Priorities 1,2,3 are high/medium/low respectively

Projects/Upgrades

Bug Fixes

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

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

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

S20 Config

Orphaned/Unknown Tasks

These are software tasks that are in an unknown state or not currently being worked

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

1. navigate to the /afs/ prod directory and mkdir <repo_name>.git
2. run git init --bare to instantiate a new empty repo
3. (if using GitHub) make a new GitHub repo with the same name
4. 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
5. do work, then git commit & git push
6. (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. 

1. ssh to centos7, navigate to /u/gu/zack/github_relay/
2. 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:
   1. git clone the repo into the github_relay directory
   2. git add remote github git@github.com:slaclab/<github_repo_name>.git
   3. add <repo_name> to /u/gu/zack/github_relay/tracked_repos.txt

Direct push to master (for minor changes or lower-impact software):

1. from your work directory: git commit, git push origin master
2. 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

1. Setup relay mirroring to GitHub as described above
2. from your work directory for the repo in question, make a new branch: git branch <branch_name>
3. make changes, commit them to <branch_name> and push the branch to /afs/
4. use sync_github.py to push the branch to GitHub
5. open a pull request, assign reviewers, review code & merge to master
6. use sync_github.py to pull the updated master branch from GitHub back to /afs/
7. deploy to production

To deploy software to production

1. 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

AIDA-PVA

F2_Orbit

F2_LEM

F2_Matching

F2_Feedback

MDL_FeedForward

F2_Wirescanner

S20 Configurator

S20 IP Waist from BPM Jitter

SLC Control System Notes

Ken Brobeck's How to restart some VMS processes guide.