📝 mrqart screenshots into readme and sphinx

NPACore · Nov 24, 2024 · a9c7500 · a9c7500
1 parent aa375a1
commit a9c7500
Show file tree

Hide file tree

Showing 4 changed files with 21 additions and 0 deletions.
diff --git a/readme.md b/readme.md
@@ -25,6 +25,14 @@ See
   smbclient -U mrqart //localhost/dicomstream/ -c 'put 001_000001_000002.dcm sim/y.dcm'
   ```
 
+## MRQART
+MR QA in Real Time (python port)
+![](sphinx/imgs/mrqart-browserUI_20241124.png)
+
+### Developing
+Use `show_debug` in a console to get a `simdata` textarea to send mock data.
+![](sphinx/imgs/show_debug.png)
+
 ## Prior Art
  * mrQA
  * sister project https://github.com/NPACore/mrqart/

diff --git a/sphinx/imgs/mrqart-browserUI_20241124.png b/sphinx/imgs/mrqart-browserUI_20241124.png
diff --git a/sphinx/imgs/show_debug.png b/sphinx/imgs/show_debug.png
diff --git a/sphinx/index.rst b/sphinx/index.rst
@@ -29,6 +29,19 @@ Code
 Overview
 --------
 
+MRQART
+++++++
+MR Quality Assurance in (near) Real Time:
+#. Samba server recieves files from scanner (iceconfig)
+#. :py:func:`mrqart.main` initializes an inotify watcher
+#. New dcm files parsed with :py:func:`dcm_checker.reader.read_dicom_tags` 
+#. Headers compared to template :py:func:`dcm_checker.check_header`
+#. Dicom vs template comparisons is sent to the web browser via web sockets 
+
+    * socket and http server managed by `mrqart`
+    * javascript in ``static/index.html`` provides client websockets ingest and styling
+
+.. image:: ../sphinx/imgs/mrqart-browserUI_20241124.png
 
 Template
 ++++++++