diff --git a/devices/statistics_writer/README.md b/devices/statistics_writer/README.md index 6111efc6bd3fc9ccbc8a0bc733b0b6ac962742c5..e2111f3d203158706f96a3eaee6004f3121f00ea 100644 --- a/devices/statistics_writer/README.md +++ b/devices/statistics_writer/README.md @@ -12,14 +12,14 @@ and writing those matrices (as well as a bunch of metadata) to hdf5. The TCP statistics writer can be called with the `tcp_hdf5_writer.py` script. This script can be called with the following arguments: ``` - --host the address to connect to - --port the port to use - --file file to read from (as opposed to host and port) - --interval The time between creating new files in hours - --output_dir specifies the folder to write all the files - --mode sets the statistics type to be decoded options: "SST", "XST", "BST" - --debug takes no arguments, when used prints a lot of extra data to help with debugging - --decimation Configure the writer to only store one every n samples. Saves storage space + -a --host the address to connect to + -p --port the port to use + -f --file file to read from (as opposed to host and port) + -i --interval The time between creating new files in hours + -o --output_dir specifies the folder to write all the files + -m --mode sets the statistics type to be decoded options: "SST", "XST", "BST" + -v --debug takes no arguments, when used prints a lot of extra data to help with debugging + -d --decimation Configure the writer to only store one every n samples. Saves storage space ``` ##HFD5 structure