From f7febf20803f6221eac7b4987cfdfccf50c7e3d7 Mon Sep 17 00:00:00 2001 From: Frederick Muriuki Muriithi Date: Fri, 4 Mar 2022 08:19:50 +0300 Subject: Document basic partial correlations dependencies * Document the things that the partial correlations feature depends on to work --- README.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/README.md b/README.md index 2dcc5b5..e500d52 100644 --- a/README.md +++ b/README.md @@ -201,3 +201,12 @@ T2 6.4471 6.7191 5.98015 6.68051 ... ``` It is very important that the column header names for the strains correspond to the genotype file used. + +## Partial Correlations + +The partial correlations feature depends on the following external systems to run correctly: + +- Redis: Acts as a communications broker between the webserver and external processes +- `sheepdog/worker.py`: Actually runs the external processes that do the computations + +These two systems should be running in the background for the partial correlations feature to work correctly. -- cgit v1.2.3