Skip to content

Update README to reflect current state of codebase#1

Merged
MaxPelly merged 2 commits intomainfrom
copilot/update-readme-to-reflect-changes
Mar 15, 2026
Merged

Update README to reflect current state of codebase#1
MaxPelly merged 2 commits intomainfrom
copilot/update-readme-to-reflect-changes

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Mar 15, 2026

README was outdated following a significant rewrite of beam_state.py. Key inaccuracies: wrong description of what beams are monitored, stale note about the script needing work, and missing documentation for new config structure and CLI args.

Changes

  • Beam monitoring: updated from generic "beam strength" to the three actual targets — TS1, TS2, and Muon beam current
  • Experiment monitoring: clarified as counts-threshold-triggered "about to finish" notification, not a generic "end of run"
  • Removed stale caveat: dropped the "needs work for other instruments / resilience" note — the script now reconnects automatically and monitors all three beam targets
  • WebSocket: noted that beam_state.py uses a real-time WebSocket with auto-reconnect
  • Config: directed users to config.ini.example as a starting point; listed all three webhook keys (news_teams_url, beam_teams_url, experiment_teams_url) with their respective scripts
  • CLI args: documented -n/--notify_current (mcr_news.py) and -nc/--notify_counts (beam_state.py, default 130)

📱 Kick off Copilot coding agent tasks wherever you are with GitHub Mobile, available on iOS and Android.

Copilot AI self-assigned this Mar 15, 2026
Co-authored-by: MaxPelly <17359435+MaxPelly@users.noreply.github.com>
Copilot AI changed the title [WIP] Update README to reflect recent changes in the codebase Update README to reflect current state of codebase Mar 15, 2026
Copilot AI requested a review from MaxPelly March 15, 2026 16:51
@MaxPelly
Copy link
Copy Markdown
Owner

Can you do the same for the antigravity branch

@MaxPelly
Copy link
Copy Markdown
Owner

@copilot can you do the same for the antigravity branch as well?

Copy link
Copy Markdown
Contributor Author

Copilot AI commented Mar 15, 2026

@copilot can you do the same for the antigravity branch as well?

I can see the antigravity branch and its codebase — it already has a fairly detailed README, but there are gaps (the [PVS], [LOGGING], [TIMEOUTS_INTERVALS], and [BEAM_BOUNDARIES] config sections aren't documented, for example).

However, I'm scoped to this PR's branch and can't push commits to antigravity directly. To get those README updates applied there, you'd need to open a new issue/task targeting that branch.

@MaxPelly MaxPelly marked this pull request as ready for review March 15, 2026 16:57
@MaxPelly MaxPelly merged commit b6402c4 into main Mar 15, 2026
1 check passed
@MaxPelly MaxPelly deleted the copilot/update-readme-to-reflect-changes branch March 15, 2026 16:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants