summaryrefslogtreecommitdiff
path: root/tools/usage.md
diff options
context:
space:
mode:
authorJeroen Schickendantz <[email protected]>2022-12-12 10:38:33 -0500
committerJeroen Schickendantz <[email protected]>2022-12-12 10:38:33 -0500
commit8557174c5ae182b493b596d2e465457a1c73ec84 (patch)
tree2c7a8c70e98aba959f111557a7919c1abbefa638 /tools/usage.md
parent3c59340e315d860f1c39d3d41e808770d0b91697 (diff)
[Feature] Graphing tool CLI update
Added CLI integration for graphing tool. Added area graphing features for graphing tool. Added PDF output for graphing tool. Added probe graph output for graphing tool.
Diffstat (limited to 'tools/usage.md')
-rw-r--r--tools/usage.md12
1 files changed, 12 insertions, 0 deletions
diff --git a/tools/usage.md b/tools/usage.md
new file mode 100644
index 0000000..d0dd358
--- /dev/null
+++ b/tools/usage.md
@@ -0,0 +1,12 @@
+To use install requirements
+
+Works with python 3.10
+ Should work with more recent
+
+To set up local venv:
+1. Create a local venv `python -m venv env`
+2. Active it (windows) `"./env/Scripts/activate.bat"`
+3. Install requirements `pip install -r requirements.txt`
+4. Run in script (need to active it or use current) `python graphing.py <dir/log filename>`
+ - Where dir is the folder for all the logs
+ - Where log filename is any specific log file set to use (will need all 5 outputs in the same directory) \ No newline at end of file