Difference between revisions of "Canu"

From UFRC
Jump to navigation Jump to search
 
(4 intermediate revisions by 2 users not shown)
Line 5: Line 5:
 
<!--CONFIGURATION: OPTIONAL (|1}} means it's ON)-->
 
<!--CONFIGURATION: OPTIONAL (|1}} means it's ON)-->
 
|{{#vardefine:conf|}}          <!--CONFIGURATION-->
 
|{{#vardefine:conf|}}          <!--CONFIGURATION-->
|{{#vardefine:exe|}}            <!--ADDITIONAL INFO-->
+
|{{#vardefine:exe|1}}            <!--ADDITIONAL INFO-->
 
|{{#vardefine:pbs|}}            <!--PBS SCRIPTS-->
 
|{{#vardefine:pbs|}}            <!--PBS SCRIPTS-->
 
|{{#vardefine:policy|}}        <!--POLICY-->
 
|{{#vardefine:policy|}}        <!--POLICY-->
 
|{{#vardefine:testing|}}      <!--PROFILING-->
 
|{{#vardefine:testing|}}      <!--PROFILING-->
 
|{{#vardefine:faq|}}            <!--FAQ-->
 
|{{#vardefine:faq|}}            <!--FAQ-->
|{{#vardefine:citation|}}      <!--CITATION-->
+
|{{#vardefine:citation|1}}      <!--CITATION-->
 
|{{#vardefine:installation|}} <!--INSTALLATION-->
 
|{{#vardefine:installation|}} <!--INSTALLATION-->
 
|}
 
|}
Line 20: Line 20:
 
Canu is a fork of the Celera Assembler designed for high-noise single-molecule sequencing (such as the PacBio RSII or Oxford Nanopore MinION).
 
Canu is a fork of the Celera Assembler designed for high-noise single-molecule sequencing (such as the PacBio RSII or Oxford Nanopore MinION).
  
<!--Modules-->
+
==Environment Modules==
==Required Modules==
+
Run <code>module spider {{#var:app}}</code> to find out what environment modules are available for this application.
  
===Serial===
 
* {{#var:app}}
 
* gcc/4.7.2
 
* gcc/5.2.0
 
<!--
 
===Parallel (OpenMP)===
 
* intel
 
* {{#var:app}}
 
===Parallel (MPI)===
 
* intel
 
* openmpi
 
* {{#var:app}}
 
-->
 
 
==System Variables==
 
==System Variables==
* HPC_{{#uppercase:{{#var:app}}}}_DIR - installation directory
+
* HPC_{{uc:{{#var:app}}}}_DIR - installation directory
 +
* HPC_{{uc:{{#var:app}}}}_BIN - executable directory
 +
* HPC_{{uc:{{#var:app}}}}_DOC - documentation directory
 +
 
 
<!--Configuration-->
 
<!--Configuration-->
 
{{#if: {{#var: conf}}|==Configuration==
 
{{#if: {{#var: conf}}|==Configuration==
Line 45: Line 35:
 
{{#if: {{#var: exe}}|==Additional Information==
 
{{#if: {{#var: exe}}|==Additional Information==
  
WRITE_ADDITIONAL_INSTRUCTIONS_ON_RUNNING_THE_SOFTWARE_IF_NECESSARY
+
When running Canu you should specify Memory and CPU usage in your command. e.g.
 +
 
 +
#SBATCH --cpus-per-task=8
 +
#SBATCH --mem=10g
 +
 
 +
-maxThreads=8
 +
-maxMemory=10g
 +
 
 +
If your canu jobs run out of memory make sure to set scheduled job resources in gridOptions and merylMemory respectively to make sure meryl does not exceed the requested memory. See [https://canu.readthedocs.io/en/latest/parameter-reference.html https://canu.readthedocs.io/en/latest/parameter-reference.html] for canu parameters.
  
 
|}}
 
|}}
Line 71: Line 69:
 
If you publish research that uses {{#var:app}} you have to cite it as follows:
 
If you publish research that uses {{#var:app}} you have to cite it as follows:
  
WRITE_CITATION_HERE
+
[http://genome.cshlp.org/content/27/5/722 Koren S, Walenz BP, Berlin K, Miller JR, Phillippy AM. Canu: scalable and accurate long-read assembly via adaptive k-mer weighting and repeat separation. Genome Research. (2017).]
  
 
|}}
 
|}}

Latest revision as of 14:26, 14 April 2020

Description

canu website  

Canu is a fork of the Celera Assembler designed for high-noise single-molecule sequencing (such as the PacBio RSII or Oxford Nanopore MinION).

Environment Modules

Run module spider canu to find out what environment modules are available for this application.

System Variables

  • HPC_CANU_DIR - installation directory
  • HPC_CANU_BIN - executable directory
  • HPC_CANU_DOC - documentation directory


Additional Information

When running Canu you should specify Memory and CPU usage in your command. e.g.

#SBATCH --cpus-per-task=8 
#SBATCH --mem=10g
-maxThreads=8
-maxMemory=10g

If your canu jobs run out of memory make sure to set scheduled job resources in gridOptions and merylMemory respectively to make sure meryl does not exceed the requested memory. See https://canu.readthedocs.io/en/latest/parameter-reference.html for canu parameters.



Citation

If you publish research that uses canu you have to cite it as follows:

Koren S, Walenz BP, Berlin K, Miller JR, Phillippy AM. Canu: scalable and accurate long-read assembly via adaptive k-mer weighting and repeat separation. Genome Research. (2017).