Skip to content

Add missing params to SMuRF file emulator tasks #925

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
BrianJKoopman merged 1 commit into from
Sep 10, 2025
Merged

Add missing params to SMuRF file emulator tasks #925

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions socs/agents/smurf_file_emulator/agent.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -558,6 +558,7 @@ def uxm_relock(self, session, params=None):
return True, "Wrote tune files"

@ocs_agent.param('wait', default=True)
@ocs_agent.param('kwargs', default=None)
@ocs_agent.param('tag', default=None)
def take_iv(self, session, params=None):
"""take_iv(wait=True, tag=None)
Expand All @@ -568,6 +569,9 @@ def take_iv(self, session, params=None):
wait (bool, optional):
If true, will wait for the 5 seconds where fake IV data is
generated
kwargs : dict
Additional kwargs to pass to the ``take_iv`` function.
Ignored in the emulator.
tag (str, optional):
User tag to add to the g3 stream.
"""
Expand Down Expand Up @@ -662,8 +666,10 @@ def bias_dets(self, session, params=None):
return True, 'Wrote det biasing files'

@ocs_agent.param('duration', default=None)
@ocs_agent.param('kwargs', default=None)
@ocs_agent.param('use_stream_between', default=False, type=bool)
@ocs_agent.param('start_offset', default=0, type=float)
@ocs_agent.param('subtype', default=None)
@ocs_agent.param('tag', default=None)
def stream(self, session, params):
"""stream(duration=None, use_stream_between=False, start_offset=0, tag=None)
Expand All @@ -678,6 +684,9 @@ def stream(self, session, params):
Parameters:
duration (float, optional):
If set, will stop stream after specified amount of time (sec).
kwargs : dict
A dictionary containing additional keyword arguments to pass.
Ignored by the emulator.
use_stream_between (bool, optional):
If True, will use the DataStreamer's `stream_between` function
instead of writing frames one at a time. This allows you to write
Expand All @@ -686,6 +695,8 @@ def stream(self, session, params):
If set, this will add an offset to the start time passed to the
`stream_between` function, allowing you to create offsets between
streams taken at the same time.
subtype : string, optional
Operation subtype used to tag the stream. Ignored by the emulator.
tag (str, optional):
User tag to add to the g3 stream.
"""
Expand Down