diff --git a/README.md b/README.md index 7c56ea2383..59638f264c 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -__SPAdes 3.13.1 Manual__ +__SPAdes 3.14.0 Manual__ 1. [About SPAdes](#sec1)
@@ -33,18 +33,18 @@ # About SPAdes -SPAdes – St. Petersburg genome assembler – is an assembly toolkit containing various assembly pipelines. This manual will help you to install and run SPAdes. SPAdes version 3.13.1 was released under GPLv2 on April 11, 2019 and can be downloaded from . []() +SPAdes – St. Petersburg genome assembler – is an assembly toolkit containing various assembly pipelines. This manual will help you to install and run SPAdes. SPAdes version 3.14.0 was released under GPLv2 on December 27, 2019 and can be downloaded from . []() ## Supported data types The current version of SPAdes works with Illumina or IonTorrent reads and is capable of providing hybrid assemblies using PacBio, Oxford Nanopore and Sanger reads. You can also provide additional contigs that will be used as long reads. -Version 3.13.1 of SPAdes supports paired-end reads, mate-pairs and unpaired reads. SPAdes can take as input several paired-end and mate-pair libraries simultaneously. Note, that SPAdes was initially designed for small genomes. It was tested on bacterial (both single-cell MDA and standard isolates), fungal and other small genomes. SPAdes is not intended for larger genomes (e.g. mammalian size genomes). For such purposes you can use it at your own risk. +Version 3.14.0 of SPAdes supports paired-end reads, mate-pairs and unpaired reads. SPAdes can take as input several paired-end and mate-pair libraries simultaneously. Note, that SPAdes was initially designed for small genomes. It was tested on bacterial (both single-cell MDA and standard isolates), fungal and other small genomes. SPAdes is not intended for larger genomes (e.g. mammalian size genomes). For such purposes you can use it at your own risk. If you have high-coverage data for bacterial/viral isolate or multi-cell organism, we highly recommend to use [`--isolate`](#isolate) option. -SPAdes 3.13.1 includes the following additional pipelines: +SPAdes 3.14.0 includes the following additional pipelines: - metaSPAdes – a pipeline for metagenomic data sets (see [metaSPAdes options](#meta)). - plasmidSPAdes – a pipeline for extracting and assembling plasmids from WGS data sets (see [plasmidSPAdes options](#plasmid)). - rnaSPAdes – a *de novo* transcriptome assembler from RNA-Seq data (see [rnaSPAdes manual](assembler/rnaspades_manual.html)). @@ -140,7 +140,7 @@ Notes: - Running SPAdes without preliminary read error correction (e.g. without BayesHammer or IonHammer) will likely require more time and memory. - Each module removes its temporary files as soon as it finishes. - SPAdes uses 512 Mb per thread for buffers, which results in higher memory consumption. If you set memory limit manually, SPAdes will use smaller buffers and thus less RAM. -- Performance statistics is given for SPAdes version 3.13.1. +- Performance statistics is given for SPAdes version 3.14.0. # Installation @@ -168,13 +168,13 @@ In case of successful installation the following files will be placed in the `bi ## Downloading SPAdes Linux binaries -To download [SPAdes Linux binaries](http://cab.spbu.ru/files/release3.13.1/SPAdes-3.13.1-Linux.tar.gz) and extract them, go to the directory in which you wish SPAdes to be installed and run: +To download [SPAdes Linux binaries](http://cab.spbu.ru/files/release3.14.0/SPAdes-3.14.0-Linux.tar.gz) and extract them, go to the directory in which you wish SPAdes to be installed and run: ``` bash - wget http://cab.spbu.ru/files/release3.13.1/SPAdes-3.13.1-Linux.tar.gz - tar -xzf SPAdes-3.13.1-Linux.tar.gz - cd SPAdes-3.13.1-Linux/bin/ + wget http://cab.spbu.ru/files/release3.14.0/SPAdes-3.14.0-Linux.tar.gz + tar -xzf SPAdes-3.14.0-Linux.tar.gz + cd SPAdes-3.14.0-Linux/bin/ ``` In this case you do not need to run any installation scripts – SPAdes is ready to use. We also suggest adding SPAdes installation directory to the `PATH` variable. []() @@ -182,13 +182,13 @@ In this case you do not need to run any installation scripts – SPAdes is r ## Downloading SPAdes binaries for Mac -To obtain [SPAdes binaries for Mac](http://cab.spbu.ru/files/release3.13.1/SPAdes-3.13.1-Darwin.tar.gz), go to the directory in which you wish SPAdes to be installed and run: +To obtain [SPAdes binaries for Mac](http://cab.spbu.ru/files/release3.14.0/SPAdes-3.14.0-Darwin.tar.gz), go to the directory in which you wish SPAdes to be installed and run: ``` bash - curl http://cab.spbu.ru/files/release3.13.1/SPAdes-3.13.1-Darwin.tar.gz -o SPAdes-3.13.1-Darwin.tar.gz - tar -zxf SPAdes-3.13.1-Darwin.tar.gz - cd SPAdes-3.13.1-Darwin/bin/ + curl http://cab.spbu.ru/files/release3.14.0/SPAdes-3.14.0-Darwin.tar.gz -o SPAdes-3.14.0-Darwin.tar.gz + tar -zxf SPAdes-3.14.0-Darwin.tar.gz + cd SPAdes-3.14.0-Darwin/bin/ ``` Just as in Linux, SPAdes is ready to use and no further installation steps are required. We also suggest adding SPAdes installation directory to the `PATH` variable. []() @@ -203,13 +203,13 @@ If you wish to compile SPAdes by yourself you will need the following libraries - zlib - libbz2 -If you meet these requirements, you can download the [SPAdes source code](http://cab.spbu.ru/files/release3.13.1/SPAdes-3.13.1.tar.gz): +If you meet these requirements, you can download the [SPAdes source code](http://cab.spbu.ru/files/release3.14.0/SPAdes-3.14.0.tar.gz): ``` bash - wget http://cab.spbu.ru/files/release3.13.1/SPAdes-3.13.1.tar.gz - tar -xzf SPAdes-3.13.1.tar.gz - cd SPAdes-3.13.1 + wget http://cab.spbu.ru/files/release3.14.0/SPAdes-3.14.0.tar.gz + tar -xzf SPAdes-3.14.0.tar.gz + cd SPAdes-3.14.0 ``` and build it with the following script: @@ -287,7 +287,7 @@ Thank you for using SPAdes! SPAdes takes as input paired-end reads, mate-pairs and single (unpaired) reads in FASTA and FASTQ. For IonTorrent data SPAdes also supports unpaired reads in unmapped BAM format (like the one produced by Torrent Server). However, in order to run read error correction, reads should be in FASTQ or BAM format. Sanger, Oxford Nanopore and PacBio CLR reads can be provided in both formats since SPAdes does not run error correction for these types of data. -To run SPAdes 3.13.1 you need at least one library of the following types: +To run SPAdes 3.14.0 you need at least one library of the following types: - Illumina paired-end/high-quality mate-pairs/unpaired reads - IonTorrent paired-end/high-quality mate-pairs/unpaired reads diff --git a/assembler/LICENSE b/assembler/LICENSE index 44db661c26..a26d33b7fc 100644 --- a/assembler/LICENSE +++ b/assembler/LICENSE @@ -28,8 +28,6 @@ Current SPAdes contributors: Dmitry Antipov, Elena Bushmanova, - Vasisliy Ershov, - Yuriy Gorshkov, Alexey Gurevich, Anton Korobeynikov, Olga Kunyavskaya, @@ -46,6 +44,8 @@ Also contributed: Max Alekseyev, Anton Bankevich, Mikhail Dvorkin, + Vasisliy Ershov, + Yuriy Gorshkov, Alexander Kulikov, Valery Lesin, Sergey Nikolenko, diff --git a/assembler/VERSION b/assembler/VERSION index c7682671cc..f982feb41b 100644 --- a/assembler/VERSION +++ b/assembler/VERSION @@ -1 +1 @@ -3.14.0-dev +3.14.0 diff --git a/assembler/manual.html b/assembler/manual.html index e0544be6c0..6195c4799c 100644 --- a/assembler/manual.html +++ b/assembler/manual.html @@ -1,4 +1,4 @@ - SPAdes 3.13.1 Manual

SPAdes 3.13.1 Manual

+ SPAdes 3.13.1 Manual

SPAdes 3.14.0 Manual

  1. About SPAdes
        1.1. Supported data types
    @@ -31,13 +31,13 @@

About SPAdes

-

SPAdes – St. Petersburg genome assembler – is an assembly toolkit containing various assembly pipelines. This manual will help you to install and run SPAdes. SPAdes version 3.13.1 was released under GPLv2 on April 11, 2019 and can be downloaded from http://cab.spbu.ru/software/spades/.

+

SPAdes – St. Petersburg genome assembler – is an assembly toolkit containing various assembly pipelines. This manual will help you to install and run SPAdes. SPAdes version 3.14.0 was released under GPLv2 on December 27, 2019 and can be downloaded from http://cab.spbu.ru/software/spades/.

Supported data types

The current version of SPAdes works with Illumina or IonTorrent reads and is capable of providing hybrid assemblies using PacBio, Oxford Nanopore and Sanger reads. You can also provide additional contigs that will be used as long reads.

-

Version 3.13.1 of SPAdes supports paired-end reads, mate-pairs and unpaired reads. SPAdes can take as input several paired-end and mate-pair libraries simultaneously. Note, that SPAdes was initially designed for small genomes. It was tested on bacterial (both single-cell MDA and standard isolates), fungal and other small genomes. SPAdes is not intended for larger genomes (e.g. mammalian size genomes). For such purposes you can use it at your own risk.

+

Version 3.14.0 of SPAdes supports paired-end reads, mate-pairs and unpaired reads. SPAdes can take as input several paired-end and mate-pair libraries simultaneously. Note, that SPAdes was initially designed for small genomes. It was tested on bacterial (both single-cell MDA and standard isolates), fungal and other small genomes. SPAdes is not intended for larger genomes (e.g. mammalian size genomes). For such purposes you can use it at your own risk.

If you have high-coverage data for bacterial/viral isolate or multi-cell organism, we highly recommend to use --isolate option.

-

SPAdes 3.13.1 includes the following additional pipelines:

+

SPAdes 3.14.0 includes the following additional pipelines:

Installation

@@ -146,17 +146,17 @@

Installation

Downloading SPAdes Linux binaries

-

To download SPAdes Linux binaries and extract them, go to the directory in which you wish SPAdes to be installed and run:

-
    wget http://cab.spbu.ru/files/release3.13.1/SPAdes-3.13.1-Linux.tar.gz
-    tar -xzf SPAdes-3.13.1-Linux.tar.gz
-    cd SPAdes-3.13.1-Linux/bin/
+

To download SPAdes Linux binaries and extract them, go to the directory in which you wish SPAdes to be installed and run:

+
    wget http://cab.spbu.ru/files/release3.14.0/SPAdes-3.14.0-Linux.tar.gz
+    tar -xzf SPAdes-3.14.0-Linux.tar.gz
+    cd SPAdes-3.14.0-Linux/bin/

In this case you do not need to run any installation scripts – SPAdes is ready to use. We also suggest adding SPAdes installation directory to the PATH variable.

Downloading SPAdes binaries for Mac

-

To obtain SPAdes binaries for Mac, go to the directory in which you wish SPAdes to be installed and run:

-
    curl http://cab.spbu.ru/files/release3.13.1/SPAdes-3.13.1-Darwin.tar.gz -o SPAdes-3.13.1-Darwin.tar.gz
-    tar -zxf SPAdes-3.13.1-Darwin.tar.gz
-    cd SPAdes-3.13.1-Darwin/bin/
+

To obtain SPAdes binaries for Mac, go to the directory in which you wish SPAdes to be installed and run:

+
    curl http://cab.spbu.ru/files/release3.14.0/SPAdes-3.14.0-Darwin.tar.gz -o SPAdes-3.14.0-Darwin.tar.gz
+    tar -zxf SPAdes-3.14.0-Darwin.tar.gz
+    cd SPAdes-3.14.0-Darwin/bin/

Just as in Linux, SPAdes is ready to use and no further installation steps are required. We also suggest adding SPAdes installation directory to the PATH variable.

Downloading and compiling SPAdes source code

@@ -167,10 +167,10 @@

Downloading and compiling SPAdes source code

  • zlib
  • libbz2
    • -

    If you meet these requirements, you can download the SPAdes source code:

    -
        wget http://cab.spbu.ru/files/release3.13.1/SPAdes-3.13.1.tar.gz
-    tar -xzf SPAdes-3.13.1.tar.gz
-    cd SPAdes-3.13.1
    +

    If you meet these requirements, you can download the SPAdes source code:

    +
        wget http://cab.spbu.ru/files/release3.14.0/SPAdes-3.14.0.tar.gz
+    tar -xzf SPAdes-3.14.0.tar.gz
+    cd SPAdes-3.14.0

    and build it with the following script:

        ./spades_compile.sh

    SPAdes will be built in the directory ./bin. If you wish to install SPAdes into another directory, you can specify full path of destination folder by running the following command in bash or sh:

    @@ -211,7 +211,7 @@

    Running SPAdes

    SPAdes input

    SPAdes takes as input paired-end reads, mate-pairs and single (unpaired) reads in FASTA and FASTQ. For IonTorrent data SPAdes also supports unpaired reads in unmapped BAM format (like the one produced by Torrent Server). However, in order to run read error correction, reads should be in FASTQ or BAM format. Sanger, Oxford Nanopore and PacBio CLR reads can be provided in both formats since SPAdes does not run error correction for these types of data.

    -

    To run SPAdes 3.13.1 you need at least one library of the following types:

    +

    To run SPAdes 3.14.0 you need at least one library of the following types: