Differences

This shows you the differences between two versions of the page.

--- prokka-software [2017/02/20 11:19] – created joguya
+++ prokka-software [2025/05/07 12:42] (current) – aorth
@@ Line 1: / Line 1: @@
-====== PROKKA ======
+====== Prokka ======
+Prokka is a software tool to annotate bacterial, archaeal and viral genomes quickly and produce standards-compliant output files.
-Prokka is a software tool for the rapid annotation of prokaryotic genomes.
 ===== Information =====
-  * Version: 1.11
+  * Version: 1.14.6
   * Added: February, 2017
-  * Link: http://www.vicbioinformatics.com/software.prokka.shtml
+  * Updated: May, 2020
+  * Link: https://github.com/tseemann/prokka
 ===== Usage =====
-See which versions of Prokka are available:
+See which versions are available:
 <code>$ module avail prokka</code>
-Load prokka
+Load one version into your environment and run it:
-<code>$ module load prokka/1.11</code>
+<code>$ module load prokka/1.14.6
+$ prokka</code>
+**Note:** Please use the %%''--cpus''%% option to tell prokka how many CPUs it should use or else it will automatically use eight (8). This number should match the number of CPUs you requested in your SLURM batch allocation.
 ===== Installation ======
@@ Line 21: / Line 26: @@
 Notes from the sysadmin during installation:
-<code>
+<code>$ cd /tmp
-$ cd /tmp/
+$ wget https://github.com/tseemann/prokka/archive/v1.14.6.tar.gz
-$ wget -qO- https://github.com/tseemann/prokka/archive/v1.11.tar.gz | tar xzv
+$ tar xf v1.14.6.tar.gz
-$ cd prokka-1.11/
+$ cd prokka-1.14.6
-$ scl enable devtoolset-3 bash
+$ mkdir perl5
-$ module load perl/5.22.3
+$ cpanm -l perl5 Time::Piece XML::Simple Digest::MD5 Module::Build
-$ cpanm SWISS::Entry SWISS::KW XML::Simple
+$ export PERL5LIB=perl5/lib/perl5
-$ sed -i 's#/usr/bin/perl.*#/usr/bin/env perl#' bin/*
+$ grep -rh -oE "use Bio::.*$" bin/* binaries/* | sort -u | awk '{print $2}' | sed 's/;//'
-$ sudo mkdir -p /export/apps/prokka/1.11
+$ cpanm -l perl5 Bio::AlignIO Bio::Root::Version Bio::SearchIO Bio::Seq Bio::SeqFeature::Generic Bio::SeqIO Bio::Tools::CodonTable Bio::Tools::GFF Bio::Tools::GuessSeqFormat --force
-$ sudo cp -rv . /export/apps/prokka/1.11/
+# we apparently also need Bio::SearchIO::hmmer3, but I only discovered that weeks later after trying to test prokka... hmmmm
-</code>
+$ cpanm -l perl5 Bio::SearchIO::hmmer3 --force
+$ ./bin/prokka --setupdb
+# Upgrade tbl2asn, see: https://github.com/tseemann/prokka/issues/511
+$ wget https://ftp.ncbi.nih.gov/toolbox/ncbi_tools/converters/by_program/tbl2asn/linux64.tbl2asn.gz
+$ gunzip  linux64.tbl2asn.gz
+$ chmod +x linux64.tbl2asn
+$ mv linux64.tbl2asn binaries/linux/tbl2asn
+$ sudo mkdir -p /export/apps/prokka/1.14.6
+$ sudo cp -r . /export/apps/prokka/1.14.6</code>
+**Note 1:** Prokka only says that it requires "BioPerl", but the BioPerl distribution frowns upon requiring the entire distribution. Here I have attempted to guess which modules are needed by checking the actual Perl "use" statements.
+**Note 2:** You can try without %%''--force''%% if you want, but many Perl modules "bail out" during installation because one out of a few hundred (or thousand) obscure or comprehensive tests fail.
+**Note 3:** As of 2025 ''tbl2asn'' is discontinued and you need to hack it with ''https://github.com/rpetit3/tbl2asn-forever'' which uses faketime to pretend it is 2019