aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorArun Isaac2025-07-17 19:36:45 +0100
committerArun Isaac2025-07-17 20:51:54 +0100
commitd785cb61a6f19003d76986a36cd4f4b7a6e21f5d (patch)
treefb1c92a7e73480b825088e917e6a2f95b6cc72c7
parent572dd0ffb8397b7338926b38c132522eb50830e3 (diff)
downloadpyhegp-d785cb61a6f19003d76986a36cd4f4b7a6e21f5d.tar.gz
pyhegp-d785cb61a6f19003d76986a36cd4f4b7a6e21f5d.tar.lz
pyhegp-d785cb61a6f19003d76986a36cd4f4b7a6e21f5d.zip
Add development version installation instructions.
* README.md (Install development version): New section.
-rw-r--r--README.md14
1 files changed, 14 insertions, 0 deletions
diff --git a/README.md b/README.md
index 27d6fd5..1396f0f 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,19 @@
pyhegp is a Python library and CLI utility implementing homomorphic encryption of genotypes and phenotypes as described in [Private Genomes and Public SNPs: Homomorphic Encryption of Genotypes and Phenotypes for Shared Quantitative Genetics](https://academic.oup.com/genetics/article/215/2/359/5930450).
+# Install development version
+
+In a new directory, create a python virtual environment and activate it.
+```
+mkdir pyhegp
+cd pyhegp
+python3 -m venv .venv
+source .venv/bin/activate
+```
+Install the development version of pyhegp into the virtual environment.
+```
+pip install git+https://github.com/encryption4genetics/pyhegp
+```
+
# Run tests
Run the test suite using