From 92727365d1e3fc67b66278fd7cbcda77dd27c09e Mon Sep 17 00:00:00 2001 From: Arun Isaac Date: Mon, 4 Aug 2025 12:40:31 +0100 Subject: Add simple workflow. * README.md (How to use): Indent down into "Joint/federated analysis with many data owners" section. [Simple data sharing]: New section. * doc/generate-images.sh: Add simple workflow. * doc/workflow.png: Rename to doc/joint-workflow.png. * doc/workflow.uml: Rename to doc/joint-workflow.uml. * doc/simple-workflow.png, doc/simple-workflow.uml: New files. * tests/test_pyhegp.py: Import pytest. (test_simple_workflow): New test. * test-data/genotype.tsv: New file. --- README.md | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) (limited to 'README.md') diff --git a/README.md b/README.md index 4378456..9fdc466 100644 --- a/README.md +++ b/README.md @@ -19,8 +19,19 @@ pip install git+https://github.com/encryption4genetics/pyhegp ``` # How to use +## Simple data sharing -![Workflow](doc/workflow.png) +![Simple data sharing workflow](doc/simple-workflow.png) + +In this simple scenario, there is only one data owner and they wish to share their encrypted data with a researcher. The data owner encrypts their data with: +``` +pyhegp encrypt -o encrypted-genotype.tsv genotype.tsv +``` +They then send the encrypted data to the researcher. Note that data sharing is carried out-of-band and is outside the scope of `pyhegp`. + +## Joint/federated analysis with many data owners + +![Joint/federated analysis workflow](doc/joint-workflow.png) Data owners generate summary statistics for their data. ``` -- cgit 1.4.1