Skip to content

Commit

Permalink
minor docs update
Browse files Browse the repository at this point in the history
  • Loading branch information
t-sasatani committed Jun 22, 2024
1 parent a962855 commit dcc433c
Showing 1 changed file with 17 additions and 0 deletions.
17 changes: 17 additions & 0 deletions miniscope_io/commands/capture.py
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,24 @@
@click.option('-s', '--source', required=False, help='RAW FPGA data to plug into okDevMock')
@click.option('-o', '--output', default='output', help='Video output filename')
def sdaqprof(config, source, output):
"""
Command to profile stream data acquisition.
This command profiles stream data acquisition based on the provided configuration and
optional source file.
Usage:
mio sdaqprof -c path/to/config.yml -s path/to/rawdata.bin -o output_filename
Parameters:
-c, --config (str): Path to the main YAML configuration file.
-s, --source (str or None): Optional path to a source configuration file for stream data mock.
-o, --output (str): Name of the output video file (without extension).
Returns:
None
"""

output_video = Path("output") / (output + ".avi")

if source:
Expand Down

0 comments on commit dcc433c

Please sign in to comment.