eccLib 1.1.0
Python library for bioinformatics written in C
|
eccLib is a library written in C for Python. This effectively means that we have two different documentation sets. One external, default that documents the Python interface, and a separate internal documentation documenting the C code. This is the internal documentation. Unless, you plan on contributing to the project, you should not need to read this.
The source code is split by designated purpose. The core module boilerplate can be found in eccLib.c
, with other core functionality in the same folder. Each Python class has a dedicated file, where the methods are defined. You can find those files in the classes
folder.
Generally speaking the code is written to be as performant as possible, with some limitations of course. Most notably goto
was generally avoided, with a few exceptions where it made more sense. Additionally no particular platform was assumed, with most system calls going through the Python/C API. Doxygen documentation was used wherever possible. For code styling clang-format
was used with the utilized style being identical to the LLVM
code style.