aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorArun Isaac2025-07-17 17:59:17 +0100
committerArun Isaac2025-07-17 20:51:54 +0100
commitd270d35cbfe9bc94d1bef16a63e3ca89e87e739e (patch)
tree75f0e67a8895c1b12fe8dacce7569d270f53123c /doc
parentd785cb61a6f19003d76986a36cd4f4b7a6e21f5d (diff)
downloadpyhegp-d270d35cbfe9bc94d1bef16a63e3ca89e87e739e.tar.gz
pyhegp-d270d35cbfe9bc94d1bef16a63e3ca89e87e739e.tar.lz
pyhegp-d270d35cbfe9bc94d1bef16a63e3ca89e87e739e.zip
Document usage instructions and workflow.
* doc/workflow.uml, doc/workflow.png, doc/generate-images.sh: New files. * README.md (How to use): New section.
Diffstat (limited to 'doc')
-rwxr-xr-xdoc/generate-images.sh3
-rw-r--r--doc/workflow.pngbin0 -> 27569 bytes
-rw-r--r--doc/workflow.uml16
3 files changed, 19 insertions, 0 deletions
diff --git a/doc/generate-images.sh b/doc/generate-images.sh
new file mode 100755
index 0000000..e1ee0ba
--- /dev/null
+++ b/doc/generate-images.sh
@@ -0,0 +1,3 @@
+#! /bin/sh
+
+cat workflow.uml | guix shell plantuml -- plantuml -p > workflow.png
diff --git a/doc/workflow.png b/doc/workflow.png
new file mode 100644
index 0000000..b2ff1b2
--- /dev/null
+++ b/doc/workflow.png
Binary files differ
diff --git a/doc/workflow.uml b/doc/workflow.uml
new file mode 100644
index 0000000..2d1542c
--- /dev/null
+++ b/doc/workflow.uml
@@ -0,0 +1,16 @@
+actor "Data Broker" as broker
+actor "Data Owner 1" as owner1
+actor "Data Owner 2" as owner2
+actor "Data Owner 3" as owner3
+owner1 -> broker: Send summary statistics
+owner2 -> broker: Send summary statistics
+owner3 -> broker: Send summary statistics
+broker --> owner1: Send pooled statistics
+broker --> owner2: Send pooled statistics
+broker --> owner3: Send pooled statistics
+owner1 -> broker: Encrypt and share ciphertext
+owner2 -> broker: Encrypt and share ciphertext
+owner3 -> broker: Encrypt and share ciphertext
+broker -> owner1: Share concatenated ciphertext
+broker -> owner2: Share concatenated ciphertext
+broker -> owner3: Share concatenated ciphertext