From c7f387f8d83b8c092f4a80ef7980e3dd92a7e357 Mon Sep 17 00:00:00 2001 From: Harry Ho Date: Wed, 28 Apr 2021 21:57:58 +0800 Subject: [PATCH] Update README --- README | 0 README.md | 16 ++++++++++++++++ 2 files changed, 16 insertions(+) delete mode 100644 README create mode 100644 README.md diff --git a/README b/README deleted file mode 100644 index e69de29..0000000 diff --git a/README.md b/README.md new file mode 100644 index 0000000..04d7a15 --- /dev/null +++ b/README.md @@ -0,0 +1,16 @@ +## Scripts + +### Python +(To see detailed usage, add `--help` as an argument when running the script.) + +* `rp_get_sayma_data.py`: Acquire and save data from RedPitayas over local network +* `plot_sayma_data.py`: Load saved data and output phase skew analysis and data plots + +### Shell + +* `mch_start`: Power on the MCH and start logging serial outputs from Metlino and Saymas +* `mch_stop`: Power off the MCH and stop logging serial outputs from Metlino and Saymas +* `get_and_plot_sayma_data`: Acquire and analyse data from RedPitayas over local network +* `get_and_plot_remote_sayma_data`: Acquire and analyse data from remote RedPitayas via SSH (often over different networks) to the local file system + * Requires Python testsuite scripts present on the remote host +