aboutsummaryrefslogtreecommitdiff
path: root/README.org
diff options
context:
space:
mode:
authorFrederick Muriuki Muriithi2022-04-27 19:06:45 +0300
committerFrederick Muriuki Muriithi2022-04-27 19:14:37 +0300
commitaadd9aa5dd4c552b573828ddac581a8b7064b0e2 (patch)
treefbf17e017af4f736ec5ea797cd777396768decfe /README.org
parent903af1c0b1f2cc695ea4e0c31438f9205571d15d (diff)
downloadgn-uploader-aadd9aa5dd4c552b573828ddac581a8b7064b0e2.tar.gz
Enable managing app via setup.py
While the application is developed with GNU Guix, the end user might not be using it, and therefore, this commit provides a way for the user to install the application with the usual python package management systems.
Diffstat (limited to 'README.org')
-rw-r--r--README.org12
1 files changed, 12 insertions, 0 deletions
diff --git a/README.org b/README.org
index 53ac63c..ecf7815 100644
--- a/README.org
+++ b/README.org
@@ -58,6 +58,18 @@ To check for correct type usage in the application, run:
*** Command-Line Version
+Clone this repository
+#+BEGIN_SRC shell
+ git clone http://git.genenetwork.org/fredmanglis/gnqc_py.git
+#+END_SRC
+then install the application
+#+BEGIN_SRC shell
+ $ python3 -m venv .venv
+ $ source .venv/bin/activate
+ (.venv) $ pip install .
+#+END_SRC
+
+
To run qc against a file, the syntax is:
#+BEGIN_SRC shell
python3 -m qc [--strainsfile <strainsfile-path>] [--verbose] <filetype> <filepath>