summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md12
1 files changed, 12 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..fdb54e4
--- /dev/null
+++ b/README.md
@@ -0,0 +1,12 @@
+# kaxxxxp-viewer - Data Logger and Viewer for KAxxxxP power supplies
+
+**kaxxxxp-viewer** acquires and visualizes voltage and current data from
+KAxxxxP power supplies. These PSUs are equipped with a USB port, which can
+be used both for remote control and data acquisition using a serial protocol.
+
+See `bin/kaxxxxp-viewer --help` for usage details.
+
+## Dependencies
+
+* Python 3 with the following modules: numpy, serial
+* Data Visualization (--plot): python3-matplotlib