Change souk_readout_tools recommended branch from dev/1.3.0 to dev/1.5.0 - #1080
Change souk_readout_tools recommended branch from dev/1.3.0 to dev/1.5.0#1080sr-cdf wants to merge 2 commits into
Conversation
Updated README to reflect the new branch version.
for more information, see https://pre-commit.ci
There was a problem hiding this comment.
Pull request overview
This PR updates the ukkid_controller documentation to recommend the newer souk_readout_tools branch (dev/1.5.0). However, it also includes substantial formatting/behavioral changes in ukkid_controller.py, which is a significantly broader scope than the PR title/description suggests.
Changes:
- Update
ukkid_controllerREADME to recommendsouk_readout_toolsbranchdev/1.5.0. - Reformat
ukkid_controller.py(imports/whitespace) and modify behavior in several control-flow areas (notably mocked sweep loops and aborters).
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 6 comments.
| File | Description |
|---|---|
| socs/agents/ukkid_controller/ukkid_controller.py | Large reformat + behavior changes; includes issues in mock sweep loops and aborter return semantics. |
| socs/agents/ukkid_controller/README.md | Updates recommended souk_readout_tools branch and cleans up formatting/whitespace. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| if session.status == 'running': | ||
| session.set_status('stopping') | ||
|
|
||
| if session.status != 'running': | ||
| return False, 'Aborted streaming RFSoc data.' |
| while ((now - sweep_start_time) < loop_time_seconds): | ||
| now = time.time() | ||
| sweep_active_seconds = (now - sweep_start_time) | ||
| sweep_status_string = "MOCK: Data has been sweeping for %.1f seconds." % (now - sweep_start_time) | ||
|
|
||
| session.data = {"value": 'SESSION ' + sweep_status_string, | ||
| "timestamp": now} | ||
|
|
||
| # Format message for publishing to Feed | ||
| message = {'block_name': 'sweep_string', | ||
| 'timestamp': now, | ||
| 'data': {'value': 'FEED ' + sweep_status_string}} | ||
| self.agent.publish_to_feed('UKKID_feed', message) | ||
|
|
||
| # Also send this string to the log - discuss whether appropriate. | ||
| self.log.info(sweep_status_string) | ||
| time.sleep(1) | ||
| now = time.time() | ||
| self.log.info('MOCK: full_band_sweep: Sweep complete.') | ||
| return True, 'MOCK: full_band_sweep: Sweep complete.' |
| if session.status == 'running': | ||
| session.set_status('stopping') | ||
|
|
||
| if session.status != 'running': | ||
| return False, 'Aborted full band sweep data.' |
| while ((now - sweep_start_time) < loop_time_seconds): | ||
| now = time.time() | ||
| sweep_active_seconds = (now - sweep_start_time) | ||
| sweep_status_string = "Data has been sweeping for %.1f seconds." % (now - sweep_start_time) | ||
|
|
||
| session.data = {"value": 'SESSION ' + sweep_status_string, | ||
| "timestamp": now} | ||
|
|
||
| # Format message for publishing to Feed | ||
| message = {'block_name': 'sweep_string', | ||
| 'timestamp': now, | ||
| 'data': {'value': 'FEED ' + sweep_status_string}} | ||
| self.agent.publish_to_feed('UKKID_feed', message) | ||
|
|
||
| # Also send this string to the log - discuss wther appropriate. | ||
| self.log.info('LOG' + sweep_status_string) | ||
| time.sleep(1) | ||
| now = time.time() | ||
| self.log.info('narrow_band_sweep: Sweep complete.') | ||
| return True, 'narrow_band_sweep: Sweep complete.' |
| if session.status == 'running': | ||
| session.set_status('stopping') | ||
|
|
||
| if session.status != 'running': | ||
| return False, 'Aborted narrow band sweep data.' |
| readout server software that runs on the RFSoCs). **Use branch dev/1.5.0** | ||
| for compatibility with the ukkid_controller agent. |
|
Confused about reported changes that I didn't make so abandoning this for now. |
The changes come from pre-commit running automatically on PRs. @wenlockedge, if you open a PR to (Unrelated, is the Copilot review a personal setting? I've tried to turn all that stuff off on the repo.) |
|
@BrianJKoopman Good to know, thanks.
I wasn't sure if it was a repo setting or not, but I checked and it was an enabled personal setting that I have since disabled. So hopefully copilot will keep quiet for now! |
Updated README to reflect the new branch version.
Description
changed readme.md
Motivation and Context
souk_readout_tools latest stable version is now 1.5.0
How Has This Been Tested?
its a readme
Types of changes
change the readme
Checklist:
I literally changed one number from 3 to 5 in two places