1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
|
# SeqAn3 -- the modern C++ library for sequence analysis
<!--
SPDX-FileCopyrightText: 2006-2025 Knut Reinert & Freie Universität Berlin
SPDX-FileCopyrightText: 2016-2025 Knut Reinert & MPI für molekulare Genetik
SPDX-License-Identifier: CC-BY-4.0
-->
[![build status][1]][2]
[![codecov][3]][4]
[![license][5]][6]
[![latest release][7]][8]
[![platforms][9]][10]
[![start][11]][12]
[![twitter][13]][14]
<!--
Above uses reference-style links with numbers.
See also https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet#links.
For example, `[![build status][1]][2]` evaluates to the following:
`[link_text][2]`
`[2]` is a reference to a link, i.e. `[link_text](https://...)`
`[link_text]` = `[![build status][1]]`
`[1]` is once again a reference to a link - this time an image, i.e. `[]
`![build status]` is the text that should be displayed if the linked resource (`[1]`) is not available
`[![build status][1]][2]` hence means:
Show the picture linked under `[1]`. In case it cannot be displayed, show the text "build status" instead.
The picture, or alternative text, should link to `[2]`.
-->
[1]: https://img.shields.io/github/actions/workflow/status/seqan/seqan3/ci_linux.yml?branch=main&style=flat&logo=github&label=SeqAn3%20CI "Open GitHub actions page"
[2]: https://github.com/seqan/seqan3/actions?query=branch%3Amain
[3]: https://codecov.io/gh/seqan/seqan3/branch/main/graph/badge.svg?token=BH1FQiBBle "Open Codecov page"
[4]: https://codecov.io/gh/seqan/seqan3
[5]: https://img.shields.io/badge/license-BSD-green.svg "Open Copyright page"
[6]: https://docs.seqan.de/seqan3/main_user/about_copyright.html
[7]: https://img.shields.io/github/release/seqan/seqan3.svg "Get the latest release"
[8]: https://github.com/seqan/seqan3/releases/latest
[9]: https://img.shields.io/badge/platform-linux%20%7C%20bsd%20%7C%20osx-informational.svg "Read more about our API"
[10]: https://docs.seqan.de/seqan3/main_user/about_api.html
[11]: https://img.shields.io/github/stars/seqan/seqan3.svg?style=social "See who starred us"
[12]: https://github.com/seqan/seqan3/stargazers
[13]: https://img.shields.io/twitter/follow/SeqAnLib.svg?label=follow&style=social "Follow us on Twitter"
[14]: https://twitter.com/seqanlib
SeqAn3 is the new version of the popular SeqAn template library for the analysis of biological sequences.
It enables the rapid development of high-performance solutions by providing generic algorithms and data structures
for:
* sequence representation and transformation
* full-text indexing and efficient search
* sequence alignment
* input/output of common file formats
By leveraging *Modern C++* it provides unprecedented ease-of-use without sacrificing performance.
Please see the [online documentation](https://docs.seqan.de/seqan3/main_user/) for more details.
## Quick facts
* C++ header-only library: easy to integrate with your app & easy to distribute
* liberal open source license: allows integration with any app or library, requires only attribution
* very high code quality standards: >97% unit test coverage, performance regression tests, ...
* extensive API documentation & tutorials: more lines of documentation than lines of code
* aims to support any 64-bit architecture running Linux/POSIX; currently big-endian CPU architectures
like s390x are less supported
## Dependencies
| | requirement | version | comment |
|-------------------|------------------------------------------------------|----------|---------------------------------------------|
|**compiler** | [GCC](https://gcc.gnu.org) | ≥ 12 | |
| | [Clang](https://clang.llvm.org) | ≥ 17 | tested with `-stdlib=libc++` |
| | [IntelOneAPI]() | ≥ 2024.0 | |
|**build system** | [CMake](https://cmake.org) | ≥ 3.20 | optional, but recommended |
|**optional libs** | [cereal](https://github.com/USCiLab/cereal) | ≥ 1.3.1 | required for serialisation and CTD support |
| | [zlib](https://github.com/madler/zlib) | ≥ 1.2 | required for `*.gz` and `.bam` file support |
| | [bzip2](https://www.sourceware.org/bzip2) | ≥ 1.0 | required for `*.bz2` file support |
## Usage
We recommend that you use CMake to build your project:
* [Setup-Tutorial](https://docs.seqan.de/seqan3/main_user/setup.html)
* Using CMake guarantees that all optional dependencies are automatically detected and activated.
|
