diff options
Diffstat (limited to 'examples/ex-tnpair/README.md')
| -rw-r--r-- | examples/ex-tnpair/README.md | 22 |
1 files changed, 22 insertions, 0 deletions
diff --git a/examples/ex-tnpair/README.md b/examples/ex-tnpair/README.md new file mode 100644 index 0000000..0eef691 --- /dev/null +++ b/examples/ex-tnpair/README.md @@ -0,0 +1,22 @@ +This example is a tumour-normal processing workflow applied to a +publically available whole-genome sequencing (WGS) dataset. As this +example uses WGS data, a large amount of data will be downloaded. +Furthermore, a large amount of space will be required to build the final +products. + +# Building on local machine + +Run `nix build -I bionix=../..` in this directory. + +# Building via HPC (slurm or torque) + +Run `nix build -f cluster.nix` to build on slurm. Note that Nix must be +configured such that the temporary build directories are created on +shared storage. + +For Torque, run `nix build -f cluster.nix -I bionix=../.. --argstr +tmpDir /scratch/`. Unlike the slurm handler, a shared tmpdir location +must be specified. + +In both cases, you may need to adjust the resource limits specified in +cluster.nix to suit your particular cluster hardware. |