aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorKyle Meyer <kyle@kyleam.com>2017-03-31 22:28:56 -0400
committerKyle Meyer <kyle@kyleam.com>2017-03-31 23:40:03 -0400
commit43f8536aee86d52e52cfa4cfc6d2e00e2ca4b04c (patch)
tree5cc8298a808015a58a3f5678ba42cab2e248a0cf
parentea8d0af781400eb5d5f6409c26f61336147fc2b5 (diff)
downloadsnakemake-mode-43f8536aee86d52e52cfa4cfc6d2e00e2ca4b04c.tar.gz
Include an example of a snakemake-shell-file-name script
-rwxr-xr-xguix-snakemake-environment11
-rw-r--r--snakemake.el5
2 files changed, 15 insertions, 1 deletions
diff --git a/guix-snakemake-environment b/guix-snakemake-environment
new file mode 100755
index 0000000..18f6c85
--- /dev/null
+++ b/guix-snakemake-environment
@@ -0,0 +1,11 @@
+#!/usr/bin/env sh
+
+### Set up a pure environment for snakemake.el commands
+###
+### If `snakemake-shell-file-name' is points to this file,
+### `snakemake-term-start` will start a terminal with an environment
+### that exposes snakemake and the dependencies defined in "guix.scm",
+### which should be located in the same directory as the current
+### Snakefile.
+
+guix environment --pure -l guix.scm --ad-hoc snakemake
diff --git a/snakemake.el b/snakemake.el
index ac2db17..278afcd 100644
--- a/snakemake.el
+++ b/snakemake.el
@@ -595,7 +595,10 @@ that starts a shell with the desired environment. For example,
to set up an enviroment with Guix, `snakemake-shell-file-name'
could point to a script that runs
- guix environment -l guix.scm --ad-hoc snakemake --pure"
+ guix environment -l guix.scm --ad-hoc snakemake --pure
+
+The file 'guix-snakemake-environment' in Snakemake mode's source
+directory can be used for this purpose."
(interactive)
(let ((default-directory (snakemake-snakefile-directory)))
(unless (snakemake-term-process)