Skip to content

Commit 7d829c3

Browse files
BrianJKoopmanlaurensaunders
authored andcommitted
Add missing params to SMuRF file emulator tasks (#925)
1 parent 9b30026 commit 7d829c3

1 file changed

Lines changed: 11 additions & 0 deletions

File tree

socs/agents/smurf_file_emulator/agent.py

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -558,6 +558,7 @@ def uxm_relock(self, session, params=None):
558558
return True, "Wrote tune files"
559559

560560
@ocs_agent.param('wait', default=True)
561+
@ocs_agent.param('kwargs', default=None)
561562
@ocs_agent.param('tag', default=None)
562563
def take_iv(self, session, params=None):
563564
"""take_iv(wait=True, tag=None)
@@ -568,6 +569,9 @@ def take_iv(self, session, params=None):
568569
wait (bool, optional):
569570
If true, will wait for the 5 seconds where fake IV data is
570571
generated
572+
kwargs : dict
573+
Additional kwargs to pass to the ``take_iv`` function.
574+
Ignored in the emulator.
571575
tag (str, optional):
572576
User tag to add to the g3 stream.
573577
"""
@@ -662,8 +666,10 @@ def bias_dets(self, session, params=None):
662666
return True, 'Wrote det biasing files'
663667

664668
@ocs_agent.param('duration', default=None)
669+
@ocs_agent.param('kwargs', default=None)
665670
@ocs_agent.param('use_stream_between', default=False, type=bool)
666671
@ocs_agent.param('start_offset', default=0, type=float)
672+
@ocs_agent.param('subtype', default=None)
667673
@ocs_agent.param('tag', default=None)
668674
def stream(self, session, params):
669675
"""stream(duration=None, use_stream_between=False, start_offset=0, tag=None)
@@ -678,6 +684,9 @@ def stream(self, session, params):
678684
Parameters:
679685
duration (float, optional):
680686
If set, will stop stream after specified amount of time (sec).
687+
kwargs : dict
688+
A dictionary containing additional keyword arguments to pass.
689+
Ignored by the emulator.
681690
use_stream_between (bool, optional):
682691
If True, will use the DataStreamer's `stream_between` function
683692
instead of writing frames one at a time. This allows you to write
@@ -686,6 +695,8 @@ def stream(self, session, params):
686695
If set, this will add an offset to the start time passed to the
687696
`stream_between` function, allowing you to create offsets between
688697
streams taken at the same time.
698+
subtype : string, optional
699+
Operation subtype used to tag the stream. Ignored by the emulator.
689700
tag (str, optional):
690701
User tag to add to the g3 stream.
691702
"""

0 commit comments

Comments
 (0)