From 07f22923fa02cdb5bb39b28b2172515f57b9c93d Mon Sep 17 00:00:00 2001 From: Wai Yi Leung <w.y.leung@e-sensei.nl> Date: Fri, 17 Jul 2015 15:08:55 +0200 Subject: [PATCH] Change year numbers and release no --- docs/about.md | 5 ++- docs/index.md | 91 ++++++++++++++++++++++++++++++++++++++++++++++++- docs/license.md | 4 +-- 3 files changed, 94 insertions(+), 6 deletions(-) mode change 120000 => 100755 docs/index.md diff --git a/docs/about.md b/docs/about.md index 309465d1c..d0775b7fc 100644 --- a/docs/about.md +++ b/docs/about.md @@ -15,8 +15,7 @@ need. ## Contributors -As of the 0.3.0 release, the following people (sorted by last name) have -contributed to Biopet: +As of the 0.4.0 release, the following people (sorted by last name) have contributed to Biopet: - Wibowo Arindrarto - Sander Bollen @@ -30,4 +29,4 @@ contributed to Biopet: Check our website at: [SASC](https://sasc.lumc.nl/) -We are also reachable through email: [SASC mail](mailto:SASC@lumc.nl) +We are also reachable through email: [SASC mail](mailto:sasc@lumc.nl) diff --git a/docs/index.md b/docs/index.md deleted file mode 120000 index 32d46ee88..000000000 --- a/docs/index.md +++ /dev/null @@ -1 +0,0 @@ -../README.md \ No newline at end of file diff --git a/docs/index.md b/docs/index.md new file mode 100755 index 000000000..a34cd136c --- /dev/null +++ b/docs/index.md @@ -0,0 +1,90 @@ +# Welcome to Biopet + + +## Introduction + +Biopet (Bio Pipeline Execution Toolkit) is the main pipeline development framework of the LUMC Sequencing Analysis Support Core team. It contains our main pipelines and some of the command line tools we develop in-house. It is meant to be used in the main [SHARK](https://humgenprojects.lumc.nl/trac/shark) computing cluster. While usage outside of SHARK is technically possible, some adjustments may need to be made in order to do so. + + +## Quick Start + +### Running Biopet in the SHARK cluster + +Biopet is available as a JAR package in SHARK. The easiest way to start using it is to activate the `biopet` environment module, which sets useful aliases and environment variables: + +~~~ +$ module load biopet/v0.4.0 +~~~ + +With each Biopet release, an accompanying environment module is also released. The latest release is version 0.4.0, thus `biopet/v0.4.0` is the module you would want to load. + +After loading the module, you can access the biopet package by simply typing `biopet`: + +~~~ +$ biopet +~~~ + +This will show you a list of tools and pipelines that you can use straight away. You can also execute `biopet pipeline` to show only available pipelines or `biopet tool` to show only the tools. What you should be aware of, is that this is actually a shell function that calls `java` on the system-wide available Biopet JAR file. + +~~~ +$ java -jar <path/to/current/biopet/release.jar> +~~~ + +The actual path will vary from version to version, which is controlled by which module you loaded. + +Almost all of the pipelines have a common usage pattern with a similar set of flags, for example: + +~~~ +$ biopet pipeline <pipeline_name> -config <path/to/config.json> -qsub -jobParaEnv BWA -retry 2 +~~~ + +The command above will do a *dry* run of a pipeline using a config file as if the command would be submitted to the SHARK cluster (the `-qsub` flag) to the `BWA` parallel environment (the `-jobParaEnv BWA` flag). We also set the maximum retry of failing jobs to two times (via the `-retry 2` flag). Doing a good run is a good idea to ensure that your real run proceeds smoothly. It may not catch all the errors, but if the dry run fails you can be sure that the real run will never succeed. + +If the dry run proceeds without problems, you can then do the real run by using the `-run` flag: + +~~~ +$ biopet pipeline <pipeline_name> -config <path/to/config.json> -qsub -jobParaEnv BWA -retry 2 -run +~~~ + +It is usually a good idea to do the real run using `screen` or `nohup` to prevent the job from terminating when you log out of SHARK. In practice, using `biopet` as it is is also fine. What you need to keep in mind, is that each pipeline has their own expected config layout. You can check out more about the general structure of our config files [here](general/config.md). For the specific structure that each pipeline accepts, please consult the respective pipeline page. + +### Running Biopet in your own computer + +At the moment, we do not provide links to download the Biopet package. If you are interested in trying out Biopet locally, please contact us as [sasc@lumc.nl](mailto:sasc@lumc.nl). + + +## Contributing to Biopet + +Biopet is based on the Queue framework developed by the Broad Institute as part of their Genome Analysis Toolkit (GATK) framework. The current Biopet release is based on the GATK 3.3 release. + +We welcome any kind of contribution, be it merge requests on the code base, documentation updates, or any kinds of other fixes! The main language we use is Scala, though the repository also contains a small bit of Python and R. Our main code repository is located at [https://git.lumc.nl/biopet/biopet](https://git.lumc.nl/biopet/biopet/issues), along with our issue tracker. + +## Local development setup + +To develop Biopet, Java 7, Maven 3.2.2, and GATK Queue 3.3 is required. Please consult the Java homepage and Maven homepage for the respective installation instruction. After you have both Java and Maven installed, you would then need to install GATK Queue. However, as the GATK Queue package is not yet available as an artifact in Maven Central, you will need to download, compile, and install GATK Queue first. + +~~~ +$ git clone https://github.com/broadgsa/gatk +$ cd gatk +$ git checkout 3.3 # the current release is based on GATK 3.3 +$ mvn -U clean install +~~~ + +This will install all the required dependencies to your local maven repository. After this is done, you can clone our repository and test if everything builds fine: + +~~~ +$ git clone git@git.lumc.nl:biopet/biopet.git +$ cd biopet +$ mvn -U clean install +~~~ + +If everything builds fine, you're good to go! Otherwise, don't hesitate to contact us or file an issue at our issue tracker. + + +## About + +Go to the [about page](about) + +## License + +See: [License](license.md) diff --git a/docs/license.md b/docs/license.md index a7d72a6dd..69a97f346 100644 --- a/docs/license.md +++ b/docs/license.md @@ -5,7 +5,7 @@ pipelines. It is mainly intended to support LUMC SHARK cluster which is running SGE. But other types of HPC that are supported by GATK Queue (such as PBS) should also be able to execute Biopet tools and pipelines. -Copyright 2014 Sequencing Analysis Support Core - Leiden University Medical Center +Copyright 2014-2015 Sequencing Analysis Support Core - Leiden University Medical Center Contact us at: sasc@lumc.nl @@ -22,4 +22,4 @@ LUMC. Please refer to https://git.lumc.nl/biopet/biopet/wikis/home for instructi on how to use this protected part of biopet or contact us at sasc@lumc.nl ~~~ - Copyright [2013-2014] [Sequence Analysis Support Core](https://sasc.lumc.nl/) + Copyright [2013-2015] [Sequence Analysis Support Core](https://sasc.lumc.nl/) -- GitLab