update

acts-project · Jun 21, 2024 · ea2f7db · ea2f7db
1 parent 2b5c2e2
commit ea2f7db
Show file tree

Hide file tree

Showing 12 changed files with 23 additions and 6 deletions.
diff --git a/docs/examples/howto/figures/gsf_debugger/gsf_debugger_0.jpg b/docs/examples/howto/figures/gsf_debugger/gsf_debugger_0.jpg
diff --git a/docs/examples/howto/figures/gsf_debugger/gsf_debugger_0.png b/docs/examples/howto/figures/gsf_debugger/gsf_debugger_0.png
diff --git a/docs/examples/howto/figures/gsf_debugger/gsf_debugger_1.jpg b/docs/examples/howto/figures/gsf_debugger/gsf_debugger_1.jpg
diff --git a/docs/examples/howto/figures/gsf_debugger/gsf_debugger_1.png b/docs/examples/howto/figures/gsf_debugger/gsf_debugger_1.png
diff --git a/docs/examples/howto/figures/gsf_debugger/gsf_debugger_2.jpg b/docs/examples/howto/figures/gsf_debugger/gsf_debugger_2.jpg
diff --git a/docs/examples/howto/figures/gsf_debugger/gsf_debugger_2.png b/docs/examples/howto/figures/gsf_debugger/gsf_debugger_2.png
diff --git a/docs/examples/howto/figures/gsf_debugger/gsf_debugger_3.png b/docs/examples/howto/figures/gsf_debugger/gsf_debugger_3.png
diff --git a/docs/examples/howto/figures/gsf_debugger/gsf_debugger_4.jpg b/docs/examples/howto/figures/gsf_debugger/gsf_debugger_4.jpg
diff --git a/docs/examples/howto/figures/gsf_debugger/gsf_debugger_4.png b/docs/examples/howto/figures/gsf_debugger/gsf_debugger_4.png
diff --git a/docs/examples/howto/figures/gsf_debugger/gsf_debugger_5.jpg b/docs/examples/howto/figures/gsf_debugger/gsf_debugger_5.jpg
diff --git a/docs/examples/howto/figures/gsf_debugger/gsf_debugger_5.png b/docs/examples/howto/figures/gsf_debugger/gsf_debugger_5.png
diff --git a/docs/examples/howto/gsf_debugger.md b/docs/examples/howto/gsf_debugger.md
@@ -1,15 +1,32 @@
 # GSF Debugger
 
+Python utility to visualize the `VERBOSE` log of a GSF track in ACTS. In general, the infrastructure could be used to also display tracks of other fitters with little adjustments.
+
+## Usage
+
+In order to run, the utility requires a logfile and a geometry description as CSV file (this can be produced using the CSV geometry writer in the examples framework):
+
+```bash
+python3 acts/Examples/Scripts/GsfDebugger/src/main.py --logfile <path-to-logfile> --detector <path-to-detector-csv>
+```
+
+Alternatively, it can also used via piping:
+```bash
+./my_gsf_script.py | acts/Examples/Scripts/GsfDebugger/src/main.py --detector <path-to-detector-csv>
+```
+
 ## Screenshots
 
-![gsf_debugger_0](figures/gsf_debugger/gsf_debugger_0.png)
+This section shows some screenshots of the provided views:
+
+![gsf_debugger_0](figures/gsf_debugger/gsf_debugger_0.jpg)
 
-![gsf_debugger_1](figures/gsf_debugger/gsf_debugger_1.png)
+![gsf_debugger_1](figures/gsf_debugger/gsf_debugger_1.jpg)
 
-![gsf_debugger_2](figures/gsf_debugger/gsf_debugger_2.png)
+![gsf_debugger_2](figures/gsf_debugger/gsf_debugger_2.jpg)
 
-![gsf_debugger_3](figures/gsf_debugger/gsf_debugger_3.png)
+![gsf_debugger_3](figures/gsf_debugger/gsf_debugger_3.jpg)
 
-![gsf_debugger_4](figures/gsf_debugger/gsf_debugger_4.png)
+![gsf_debugger_4](figures/gsf_debugger/gsf_debugger_4.jpg)
 
-![gsf_debugger_5](figures/gsf_debugger/gsf_debugger_5.png)
+![gsf_debugger_5](figures/gsf_debugger/gsf_debugger_5.jpg)