diff options
author | Arun Isaac | 2025-08-04 12:40:31 +0100 |
---|---|---|
committer | Arun Isaac | 2025-08-06 22:40:41 +0100 |
commit | 92727365d1e3fc67b66278fd7cbcda77dd27c09e (patch) | |
tree | da98acd067d28aae09123a24b6527d757fe4bec8 /README.md | |
parent | 9e2fbdb8141549cbaf4688e52f62fec0b720d8b8 (diff) | |
download | pyhegp-92727365d1e3fc67b66278fd7cbcda77dd27c09e.tar.gz pyhegp-92727365d1e3fc67b66278fd7cbcda77dd27c09e.tar.lz pyhegp-92727365d1e3fc67b66278fd7cbcda77dd27c09e.zip |
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.
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 13 |
1 files changed, 12 insertions, 1 deletions
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 - + + +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 + + Data owners generate summary statistics for their data. ``` |