Create UKKID Controller agent by wenlockedge · Pull Request #1083 · simonsobs/socs

wenlockedge · 2026-07-10T15:53:19Z

Creating a pull request as request by Brian Koopman on 10 July 2026.

Description

Motivation and Context

How Has This Been Tested?

Types of changes

Bug fix (non-breaking change which fixes an issue)
New feature (non-breaking change which adds functionality)
Breaking change (fix or feature that would cause existing functionality to not work as expected)

Checklist:

My code follows the code style of this project.
My change requires a change to the documentation.
I have updated the documentation accordingly.

…hanges to g3 file being written out with observation and wiring frames

…ols. Note - note complete at the moment.

… and should work with standard workflow.

…ufm_kid1 or ufm_kid2

…t 70580bcf

for more information, see https://pre-commit.ci

BrianJKoopman

Thanks for PRing this @wenlockedge, and apologies it took so long to get to. Lots of comments below. I'm happy to help addressing some of them, like the packaging bits.

BrianJKoopman · 2026-09-01T18:13:58Z

Let's not commit a 49 MB .csv file here. That ~doubles the size of cloning this entire repo.

Hi,
Yes, it makes sense to only allow actual code, rather than ancillary data files, in the repo. However, this file is required for the code to work properly in mocked mode. Do you have a recommendation for the best place for it can go such that it is publicly accessible and can be downloaded by someone following the install procedure in README.md? Something like a personal google drive/dropbox/ or git repo doesn't seem like the right solution...

BrianJKoopman · 2026-09-01T18:14:33Z

Drop this one too.

BrianJKoopman · 2026-09-01T18:47:05Z

+
+2. souk_readout_tools. This is the python code for the readout client
+described above (note this repository also contains the code for the
+readout server software that runs on the RFSoCs). **Use branch main**


The "Use branch main" conflicts with "Be sure to select branch dev/1.3.0 from the pull down menu on github before cloning this repository." below. Which branch is recommended?

BrianJKoopman · 2026-09-01T19:18:36Z

+The way I am doing this (there may be a more elegant way) is to create a soflink from the default "agents" directory in your default OCS installed to point at the
+ukkid_controller directory within the SOCS directory tree. On my system I had installed ocs in /home/leechj/ocs and socs in /home/leechj/socs, so I did.


Yes, there is a more elegant way. ocs is capable of launching any agent registered with a given 'ocs plugin'. socs is an ocs plugin. All agents within socs are 'registered' in the file plugin.py.

So a few recommendations to match the standards already in place in socs are:

Rename ukkid_controller.py to agent.py. (Just for consistency really.)

Add a line in plugin.py for the UKKIDController.

Create an __init__.py file in socs/socs/agents/ukkid_controller/. This makes a regular package that can be imported. This'll be a blank file.

Once you do this, remove this whole "Making the UKKID_controller.py agent available to your OCS install" section.

BrianJKoopman · 2026-09-01T20:14:25Z

+1. An Observatory Control System (OCS) installation.
+
+2. souk_readout_tools. This is the python code for the readout client
+described above (note this repository also contains the code for the
+readout server software that runs on the RFSoCs). **Use branch main**
+for compatibility with the ukkid_controller agent.
+
+3. The ukkid_controller agent itself - i.e. everything within the
+agents/UKKIDcontroller directory. This can be obtained by checking out
+the "ukkid_agent" branch of the official "socs" Simons Observatory
+repository.


This might make sense for a guide on Confluence or similar, but 1 and 3 don't really make sense to include in this context. ocs is a requirement for socs (i.e. it gets installed by the socs installation automatically. And the ukkid_controller agent is getting packaged into socs -- of course it's included.

BrianJKoopman · 2026-09-03T19:43:22Z

+            while self.client.get_info(['server'])[0]['latest_sweep_data_valid'] is False:
+                self.log.info('Waiting for scan to complete, sleeping for 1 second.')
+                time.sleep(1)


What if the server never reports a valid sweep? Seems like we could get stuck here if there's an issue on the server end.

BrianJKoopman · 2026-09-03T19:52:44Z

+    def _abort_narrow_band_sweep(self, session, params):
+        if session.status == 'running':
+            session.set_status('stopping')
+
+        if session.status != 'running':
+            return False, 'Aborted narrow band sweep data.'


Like the others, this aborter doesn't do anything unless the task handles the change in status appropriately.

BrianJKoopman · 2026-09-03T20:30:33Z

+                self.log.info('Accurate Frequencies extracted from ' + f_accurate_filename)
+
+            # At this point. f_accurate_list should defined.
+            self.log.info('set_tone_frequencies: Will use tone frequencies of ' + str(f_accurate_list))


How long is this list in practice?

BrianJKoopman · 2026-09-03T20:32:26Z

+            # JL write something to the feed here?
+            return True, 'set_tone_frequencies: complete.'
+
+    def get_tone_frequencies(self, session, params=None):


How are these 'get_X' tasks used in practice?

BrianJKoopman · 2026-09-03T20:37:50Z

I've left some of these as detailed comments below, but some general comments:

You don't need to/shouldn't publish log style messages to the feed. Things like "Expected key f_guess_list not found in json file..." don't need to be kept forever in the .g3 file archive. That's more appropriate as a log message. They're useful when that message just occurred, but less so on data that's years old.

You probably don't need to put those types of log messages into session.data either. Some sort of 'status' key/value like 'streaming: True' makes sense, but long log messages fit better in the stdout log.

There's a lot of 'go find the latest relevant file' code in this agent, which would probably make more sense to abstract away to either a 'driver module' or to the souk_readout_tools package. This doesn't have to happen now, but it would clean up the agent a bit to do it eventually.

wenlockedge and others added 19 commits March 30, 2026 14:26

First commit

53227c1

Streaming task now takes an explicit duration parameter, to support c…

29e1759

…hanges to g3 file being written out with observation and wiring frames

Partial reworking of the agent to work with v1.1.1 of souk_readout_to…

056dffa

…ols. Note - note complete at the moment.

More fixes to agent to work with v1.3.0 of souk_readout_tools. Tested…

992078f

… and should work with standard workflow.

Added explicit window size parameter to det_res_freq_from_sweep_data

d998b07

Updated README

7949e38

Added dual pipline support, based on supplied command line argument, …

ded667d

…ufm_kid1 or ufm_kid2

Changed default simulated sweeps to 332 resonators ones

aea2b38

Updated narrow band sweep files

d9575e5

Updated narrow band sweep files (png)

d20b348

tweaks to get working in new mocked, mode, improved log comments

bd9abb2

Tidied up setting of installation souk_readout_tools specific variables

47d8eb3

Updated README.md

4824566

Updated README.md

8c6eb6c

Updated README.md

20f5647

Fixed up and tested to work with souk_readout_tools main branch commi…

e038e42

…t 70580bcf

Updated README.md to clarify issues with python environments

3bcafec

[pre-commit.ci] auto fixes from pre-commit.com hooks

b45a306

for more information, see https://pre-commit.ci

Fixed pre-commit.co,errors

8d18d2e

BrianJKoopman mentioned this pull request Jul 17, 2026

Change souk_readout_tools recommended branch from dev/1.3.0 to dev/1.5.0 #1080

Closed

Merge branch 'main' into ukkid_agent

31adb6f

BrianJKoopman self-requested a review September 1, 2026 18:27

BrianJKoopman changed the title ~~Ukkid agent - pull request to main~~ Create UKKID Controller agent Sep 1, 2026

BrianJKoopman added the new agent New OCS agent needs to be created label Sep 2, 2026

BrianJKoopman requested changes Sep 3, 2026

View reviewed changes

Navigation Menu

Uh oh!

Create UKKID Controller agent - #1083

Create UKKID Controller agent#1083
wenlockedge wants to merge 20 commits into
mainfrom
ukkid_agent

wenlockedge commented Jul 10, 2026

Uh oh!

BrianJKoopman left a comment

Uh oh!

BrianJKoopman Sep 1, 2026

Uh oh!

wenlockedge Sep 7, 2026

Uh oh!

BrianJKoopman Sep 1, 2026

Uh oh!

wenlockedge Sep 7, 2026

Uh oh!

BrianJKoopman Sep 1, 2026

Uh oh!

BrianJKoopman Sep 1, 2026

Uh oh!

BrianJKoopman Sep 1, 2026

Uh oh!

BrianJKoopman Sep 3, 2026

Uh oh!

BrianJKoopman Sep 3, 2026

Uh oh!

BrianJKoopman Sep 3, 2026

Uh oh!

BrianJKoopman Sep 3, 2026

Uh oh!

BrianJKoopman Sep 3, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

		The way I am doing this (there may be a more elegant way) is to create a soflink from the default "agents" directory in your default OCS installed to point at the
		ukkid_controller directory within the SOCS directory tree. On my system I had installed ocs in /home/leechj/ocs and socs in /home/leechj/socs, so I did.

Uh oh!

Conversation

wenlockedge commented Jul 10, 2026

Description

Motivation and Context

How Has This Been Tested?

Types of changes

Checklist:

Uh oh!

BrianJKoopman left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants