Some CLI Tools For The Secure Multi-party Genomic Analysis Website
Project description
sfkit
sfkit
is a collection of CLI tools to help run certain types of secure multi-party computation on genomic data. It is a companion to the website here.
Documentation
You can read the full documentation here.
Prerequisites
Installation
pip install sfkit
Usage
Usage: sfkit <auth | setup_networking | generate_personal_keys | register_data | encrypt_data (MPC-only) | run_protocol>
- auth: Authenticate with the CLI.
- set_study (deprecated): Set the study you are using.
- setup_networking: Setup the networking, including your IP address and any relevant ports.
- generate_personal_keys: Generate your public and private cryptographic keys for use in encrypting the data.
- register_data: Register and validate your data.
- encrypt_data: Encrypt your data. (used only in the MPC GWAS protocol)
- run_protocol: Run the protocol. As this command may be long-running, it is recommended that you run it using nohup. This will prevent it from terminating if you close this window/terminal. For example,
nohup sfkit run_protocol & tail -f nohup.out
. You can also use a tool like screen or tmux.
Questions
If you have questions or concerns, you can reach me at smendels@broadinstitute.org.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distributions
No source distribution files available for this release.See tutorial on generating distribution archives.
Built Distribution
sfkit-0.0.79-py3-none-any.whl
(618.8 kB
view hashes)