aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorPjotr Prins2020-04-09 17:02:38 -0500
committerPjotr Prins2020-04-09 17:02:38 -0500
commitbf93a6a2fec690eee4bff4891469cd5947102b3a (patch)
tree103d82f4800aef14a66591341e19c5373a33d422 /doc
parent0670ac0644c1e7366952e254bdee2db62e673275 (diff)
downloadbh20-seq-resource-bf93a6a2fec690eee4bff4891469cd5947102b3a.tar.gz
bh20-seq-resource-bf93a6a2fec690eee4bff4891469cd5947102b3a.tar.lz
bh20-seq-resource-bf93a6a2fec690eee4bff4891469cd5947102b3a.zip
Moved Guix documentation into separate file (as it confused people ;)
Diffstat (limited to 'doc')
-rw-r--r--doc/INSTALL.md31
1 files changed, 31 insertions, 0 deletions
diff --git a/doc/INSTALL.md b/doc/INSTALL.md
new file mode 100644
index 0000000..c5c486c
--- /dev/null
+++ b/doc/INSTALL.md
@@ -0,0 +1,31 @@
+# INSTALLATION
+
+Other options for running this tool.
+
+## GNU Guix
+
+Another way to install this tool is inside a [GNU Guix Environment](https://guix.gnu.org/manual/en/html_node/Invoking-guix-environment.html), which can handle installing dependencies for you even when you don't have root access on an Ubuntu system.
+
+1. **Set up and enter a container with the necessary dependencies.** After installing Guix as `~/opt/guix/bin/guix`, run:
+
+```sh
+~/opt/guix/bin/guix environment -C guix --ad-hoc git python openssl python-pycurl nss-certs
+```
+
+2. **Install the tool.** From there you can follow the [user installation instructions](#installation-with-pip3---user). In brief:
+
+```sh
+pip3 install --user schema-salad arvados-python-client
+```
+
+Pip installed the following modules
+
+```
+arvados-python-client-2.0.1 ciso8601-2.1.3 future-0.18.2 google-api-python-client-1.6.7 httplib2-0.17.1 oauth2client-4.1.3 pyasn1-0.4.8 pyasn1-modules-0.2.8 rsa-4.0 ruamel.yaml-0.15.77 six-1.14.0 uritemplate-3.0.1 ws4py-0.5.1
+```
+
+3. Run the tool directly with
+
+```sh
+~/opt/guix/bin/guix environment guix --ad-hoc git python openssl python-pycurl nss-certs -- python3 bh20sequploader/main.py
+```