Skip to content

Commit

Permalink
Updated image version and sample dataset locations
Browse files Browse the repository at this point in the history
  • Loading branch information
piotrszul committed Dec 12, 2019
1 parent 9051130 commit 73dd52e
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 6 deletions.
12 changes: 7 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ phasing and filtering on MAF).

Download and uncompress example data (390 MB)

wget https://s3-ap-southeast-2.amazonaws.com/csiro-tribes/downloads/examples/TFCeu.tar.gz
wget https://s3-ap-southeast-2.amazonaws.com/csiro-tribes/downloads/examples/0.1/TFCeu.tar.gz
tar -xzf TFCeu.tar.gz
rm TFCeu.tar.gz (optionally)

Expand All @@ -92,11 +92,11 @@ To run from a local installation do to your *TRIBES* installation directory and

To run using `docker`:

docker run -it -rm -v "$HOME/tribes-data:$HOME/tribes-data" docker.io/piotrszul/tribes -d $HOME/tribes-data/TFCeu -j <no_cpu_cores> estimate_degree_vs_true
docker run -it -rm -v "$HOME/tribes-data:$HOME/tribes-data" docker.io/piotrszul/tribes:0.1.1 -d $HOME/tribes-data/TFCeu -j <no_cpu_cores> estimate_degree_vs_true

To run using `singularity`:

singularity run -e docker://docker.io/piotrszul/tribes -d $HOME/tribes-data/TFCeu -j <no_cpu_cores> estimate_degree_vs_true
singularity run -e docker://docker.io/piotrszul/tribes:0.1.1 -d $HOME/tribes-data/TFCeu -j <no_cpu_cores> estimate_degree_vs_true


Where `no_cpu_cores` is the number of CPU cores to use. `estimate_degree_vs_true` calls *TRIBES* to perform all relatedness estimation steps described in `IBD/Relatedness steps:` under [Preparing a custom pipeline](#Preparing-a-custom-pipeline)
Expand Down Expand Up @@ -299,10 +299,13 @@ The pedigree is defined in `g1k_ceu_family_15_2.ped` and includes 15 generations

# Containers

*TRIBES* docker image includes the pipeline and all the dependences and it's publicly available from https://hub.docker.com/r/piotrszul/tribes and can pulled with:
*TRIBES* docker image includes the pipeline and all the dependences and it's publicly available from https://hub.docker.com/r/piotrszul/tribes as `docker.io/piotrszul/tribes` and the most
recent version can pulled with:

docker pull docker.io/piotrszul/tribes

To use a specifc version e.g.: `0.1.1` please use `docker.io/piotrszul/tribes:0.1.1` as the docker image name.

It's an executable image with `snakemake` as an entry point.

When running using docker it's necessary to mount the reference data and pipeline data volumes (or local filesystem) so that the container have access to both, e.g:
Expand All @@ -316,7 +319,6 @@ When running with `singularity` this may not be need if the volumes with data an
singularity run -e docker://docker.io/piotrszul/tribes -d <path-to-data> <other_options> ...



# Issues and comments

Please report any issues or ideas at: https://github.com/aehrc/TRIBES/issues
Expand Down
2 changes: 1 addition & 1 deletion Snakefile
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@

# Condiguration

singularity: "docker://docker.io/piotrszul/tribes"
singularity: "docker://docker.io/piotrszul/tribes:0.1.1"
configfile: "config.yaml"

include: "core.smake"
Expand Down

0 comments on commit 73dd52e

Please sign in to comment.