Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
Mosaicatcher Update
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Wiki
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Package Registry
Container Registry
Model registry
Operate
Environments
Terraform modules
Monitor
Incidents
Service Desk
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
Thomas Weber
Mosaicatcher Update
Commits
8f3c5809
Commit
8f3c5809
authored
6 years ago
by
Sascha Meiers
Browse files
Options
Downloads
Patches
Plain Diff
More README updates
parent
0e5045c0
No related branches found
Branches containing commit
No related tags found
Tags containing commit
No related merge requests found
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
README.md
+15
-6
15 additions, 6 deletions
README.md
with
15 additions
and
6 deletions
README.md
+
15
−
6
View file @
8f3c5809
...
...
@@ -78,7 +78,11 @@ of this pipeline, which can be used in Snakemake together with
1.
**Singularity required.**
We tested this with version 2.5.1.
2.
**Run Snakemake with `--use-singularity` option.**
The software inside the
2.
**Provide SNP call set (optional).**
External VCF files (if available) should be
*copied*
into a subfolder of the pipeline, which can be read from within the image.
Accordingly, you need to specify a relative path in
`Snake.config-singularity.json`
.
3.
**Run Snakemake with `--use-singularity` option.**
The software inside the
Singularity image need to access external data, such as the reference genome.
These are specified in a separate config file.
...
...
@@ -104,10 +108,6 @@ of this pipeline, which can be used in Snakemake together with
> **Note:** Currently only hg38 is supported within the singularity inmage.
3.
**SNP call set.**
External VCF files (if available) should be
*copied*
into a
subfolder of the pipeline, which can be read from within the image. Also specify
a relative path in
`Snake.config-singularity.json`
.
### Option 2: Bioconda environment
...
...
@@ -158,7 +158,7 @@ In case you do not have Conda yet, it is easiest to just install
3.
Run
`snakemake`
##
Snakemake recommendations
##
Cluster support (experimental)
You can ask Snakemake to submit your jobs to a HPC cluster. We provided a config
file (
`cluster.json`
) for this purpose, yet it might need to be adapted to your
...
...
@@ -177,6 +177,15 @@ infrastructure. Here is an example command:
--latency-wait 60
```
In the HPC system this was tested (based on SLURM), Snakemake sometimes does not
recognize if a job was killed on the cluster and hangs up waiting for it to finish.
To overcome this, we provide a small script called
`cluster_status.py`
which can
be passed to Snakemake as shown below. Note that this script might need to be adapted.
```
--cluster-status cluster_status.py
```
Finally, of course the cluster mode can be combined with
`--use-singularity`
.
...
...
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment