diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 32 |
1 files changed, 30 insertions, 2 deletions
diff --git a/README.md b/README.md index 2c5b125..83b0c68 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,8 @@ pyhegp is a Python library and CLI utility implementing homomorphic encryption o - [Using encrypted genotypes and phenotypes for collaborative genomic analyses to maintain data confidentiality](https://academic.oup.com/genetics/article/226/3/iyad210/7470728) # Install development version -## Create a virtual environment (optional) +## Using pip +### Create a virtual environment (optional) In a new directory, create a python virtual environment and activate it. ``` mkdir pyhegp @@ -13,12 +14,39 @@ cd pyhegp python3 -m venv .venv source .venv/bin/activate ``` -## Install pyhegp +### Install pyhegp Install the development version of pyhegp. If you are in a virtual environment, pyhegp will be installed in it. If you skipped the previous step, pyhegp will be installed in your user install directory (that's typically in your home directory). ``` pip install git+https://github.com/encryption4genetics/pyhegp ``` +## Using Guix + +Put the following into a `channels.scm` file. +```scheme +(use-modules (guix ci)) + +(list (channel + (name 'pyhegp) + (url "https://github.com/encryption4genetics/pyhegp") + (branch "main")) + (channel-with-substitutes-available %default-guix-channel + "https://ci.guix.gnu.org")) +``` +Build a Guix profile using this `channels.scm` and activate it. +``` +guix pull -C channels.scm -p pyhegp-profile +source ./pyhegp-profile/etc/profile +``` +Drop into a shell where pyhegp is installed. +``` +guix shell pyhegp +``` +Now, you can use pyhegp. +``` +pyhegp --help +``` + # How to use ## Simple data sharing |