|
Name |
|
Date |
Size |
#Lines |
LOC |
| .. | | 03-May-2022 | - |
| apps/ | H | 03-May-2022 | - | 1,483,608 | 1,436,660 |
| demos/ | H | 03-May-2022 | - | 35,526 | 26,884 |
| dox/ | H | 03-May-2022 | - | 953 | 784 |
| include/seqan/ | H | 02-Feb-2018 | - | 334,350 | 183,455 |
| manual/ | H | 03-May-2022 | - | 20,275 | 13,980 |
| tests/ | H | 03-May-2022 | - | 208,350 | 160,552 |
| util/ | H | 02-Feb-2018 | - | 57,915 | 49,421 |
| .gitattributes | H A D | 02-Feb-2018 | 1 KiB | 52 | 49 |
| .gitignore | H A D | 02-Feb-2018 | 87 | 10 | 9 |
| .travis.yml | H A D | 02-Feb-2018 | 3.5 KiB | 87 | 78 |
| CHANGELOG.rst | H A D | 02-Feb-2018 | 24 KiB | 704 | 540 |
| CONTRIBUTING.rst | H A D | 02-Feb-2018 | 1.3 KiB | 26 | 15 |
| LICENSE | H A D | 02-Feb-2018 | 1.5 KiB | 27 | 23 |
| README.rst | H A D | 02-Feb-2018 | 2.3 KiB | 56 | 41 |
README.rst
1.. image:: https://readthedocs.io/projects/seqan/badge/?version=develop
2 :target: https://seqan.readthedocs.io/en/develop?badge=develop
3 :alt: Documentation Status
4
5SeqAn - The Library for Sequence Analysis
6=========================================
7
8What Is SeqAn?
9--------------
10
11SeqAn is an open source C++ library of efficient algorithms and data structures for the analysis of sequences with the focus on biological data.
12Our library applies a unique generic design that guarantees high performance, generality, extensibility, and integration with other libraries.
13SeqAn is easy to use and simplifies the development of new software tools with a minimal loss of performance.
14
15License
16-------
17
18The SeqAn library itself, the tests and demos are licensed under the very permissing 3-clause BSD License.
19The licenses for the applications themselves can be found in the LICENSE files.
20
21Prerequisites
22-------------------
23
24Linux, MacOS, FreeBSD:
25 * GCC ≥ 5 [limited GCC-4.9 support on Linux]
26 * Clang/LLVM ≥ 3.6 [limited Clang-3.5 support on Linux]
27 * Intel Compiler ≥ 17.0.0 on Linux
28Windows:
29 * Visual C++ ≥ 14.0 / Visual Studio ≥ 2015
30 * Intel Compiler ≥ 17.0.0 / Visual Studio ≥ 2015u2
31 * Clang/C2 ≥ 3.8.0 / Visual Studio ≥ 2015u3 [experimental, requires CMake ≥ 3.6]
32
33Architecture support:
34 * Intel/AMD platforms, including optimisations for modern instruction sets (``POPCNT``, ``SSE4``, ``AVX2``, ``AVX512``)
35 * All Debian release architectures supported, including most ARM and all PowerPC platforms.
36
37To build tests, demos, and official SeqAn applications you also need:
38 * CMake ≥ 3.0 [CMake ≥ 3.4 recommended]
39
40Some of the official applications might have additional requirements or work only on a subset of platforms.
41
42Documentation Resources
43-----------------------
44
45* `Getting Started <http://seqan.readthedocs.io/en/master/Tutorial/GettingStarted>`_
46* `Manual <http://seqan.readthedocs.io/en/master>`_
47* `Tutorial <http://seqan.readthedocs.io/en/master/index.html#tutorials>`_
48* `How-Tos <http://seqan.readthedocs.io/en/master/Tutorial/HowTo>`_
49* `API Documentation (stable) <http://docs.seqan.de/seqan/master/>`_
50
51Contact
52=======
53
54* `Mailing List <https://lists.fu-berlin.de/listinfo/seqan-dev#subscribe>`_
55* `GitHub Project (issues, source code) <https://github.com/seqan/seqan>`_
56