diff --git a/README.md b/README.md index 8d39731a5cdb9de0aa5f6f1001e89f9a1fb43743..29df9eead4c309e0e3c0fb57447bd7f9261705a7 100644 --- a/README.md +++ b/README.md @@ -13,68 +13,7 @@ git pull upstream master These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system. -### Prerequisites - -To run nextflow on you computer you need to have java (>= 1.8) installed. - -```sh -java --version -``` - -To be able to easily test tools already implemented for nextflow on your computer (`src/nf_modules/` to see their list). You need to have docker installed. - -```sh -docker run hello-world -``` - -### Installing - -To install nextflow on you computer simply run the following command: - -```sh -src/install_nextflow.sh -``` - -Then to initialize a given tools run the following command: - -```sh -src/docker_modules/<tool_name>/<tool_version>/docker_init.sh -``` - -For example to initialize `file_handle` version `0.1.1`, run: - -```sh -src/docker_modules/file_handle/0.1.1/docker_init.sh -``` - -To initialize all the tools: -```sh -find src/docker_modules/ -name "docker_init.sh" | awk '{system($0)}' -``` - -## Running the tests - -To run tests we first need to get a training set -```sh -cd data -git clone -c http.sslVerify=false https://gitlab.biologie.ens-lyon.fr/LBMC/tiny_dataset.git -cp tiny_dataset/fastq/tiny_R1.fastq tiny_dataset/fastq/tiny2_R1.fastq -cp tiny_dataset/fastq/tiny_R2.fastq tiny_dataset/fastq/tiny2_R2.fastq -cp tiny_dataset/fastq/tiny_S.fastq tiny_dataset/fastq/tiny2_S.fastq -cd .. -``` - -Then to run the tests for a given tools run the following command: - -```sh -src/nf_modules/<tool_name>/<tool_version>/tests.sh -``` - -For example to run the tests on `Bowtie2` run: - -```sh -src/nf_modules/bowtie2/tests.sh -``` +[you can follow them here.](doc/getting_started.md) ## Available tools diff --git a/doc/getting_started.md b/doc/getting_started.md new file mode 100644 index 0000000000000000000000000000000000000000..e8446e5b9d12a60e9330f4bb40f301f7c17e59b2 --- /dev/null +++ b/doc/getting_started.md @@ -0,0 +1,66 @@ +## Getting Started + +These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system. + +### Prerequisites + +To run nextflow on you computer you need to have java (>= 1.8) installed. + +```sh +java --version +``` + +To be able to easily test tools already implemented for nextflow on your computer (`src/nf_modules/` to see their list). You need to have docker installed. + +```sh +docker run hello-world +``` + +### Installing + +To install nextflow on you computer simply run the following command: + +```sh +src/install_nextflow.sh +``` + +Then to initialize a given tools run the following command: + +```sh +src/docker_modules/<tool_name>/<tool_version>/docker_init.sh +``` + +For example to initialize `file_handle` version `0.1.1`, run: + +```sh +src/docker_modules/file_handle/0.1.1/docker_init.sh +``` + +To initialize all the tools: +```sh +find src/docker_modules/ -name "docker_init.sh" | awk '{system($0)}' +``` + +## Running the tests + +To run tests we first need to get a training set +```sh +cd data +git clone -c http.sslVerify=false https://gitlab.biologie.ens-lyon.fr/LBMC/tiny_dataset.git +cp tiny_dataset/fastq/tiny_R1.fastq tiny_dataset/fastq/tiny2_R1.fastq +cp tiny_dataset/fastq/tiny_R2.fastq tiny_dataset/fastq/tiny2_R2.fastq +cp tiny_dataset/fastq/tiny_S.fastq tiny_dataset/fastq/tiny2_S.fastq +cd .. +``` + +Then to run the tests for a given tools run the following command: + +```sh +src/nf_modules/<tool_name>/<tool_version>/tests.sh +``` + +For example to run the tests on `Bowtie2` run: + +```sh +src/nf_modules/bowtie2/tests.sh +```