How jhhlab/biovoltron works
Project type and purpose
• This is a C++ bioinformatics library (“biovoltron”) that provides:
• File‐I/O for FASTA/FASTQ formats
• In‐memory container types (bit vectors)
• Core algorithms (e.g., suffix sorting)
• Utility routines (string handling, logging)
• It is delivered as a modular library built with CMake, with submodules for third-party dependencies, tested via Catch2, and documented via Doxygen.
File structure
• Top-level:
• CMakeLists.txt – orchestrates build of library, tests, docs
• /biovoltron – public headers organized into algo, container, file_io, utility
• submodules – git submodules for boost-cmake, bzip2, doxygen-css, htslib, libsimdpp, range-v3, spdlog, tbb
• tests – unit tests organized in parallel to modules
• docs – Doxygen config and markdown tutorials
• .github/workflows – CI definitions for build, test, deploy
README (docs/markdown/index.md)
• Likely outlines installation, usage examples (file I/O tutorials, algorithm demos) and links to generated API docs.
• May call out supported file formats and core performance features (SIMD, TBB parallelism).
a. Core Library Modules:
• file_io (FASTA/FASTQ Reader/Writer)
• container (xbit_vector, dibit_vector)
• algo (suffix_sorter: core & stable_sorter)
• utility (istring, logging facade)
b. External Dependencies (submodules):
• build support: boost-cmake
• compression: bzip2
• I/O helpers: htslib
• parallelism: TBB
• algorithm support: libsimdpp, range-v3
• logging: spdlog
• docs styling: doxygen-awesome-css
c. Build & CI:
• CMake → library + tests + docs
• GitHub Actions workflows (pull-request-check + deploy)
d. Documentation:
• Doxygen pipeline (Doxyfile, custom CSS, header, layout)
• markdown tutorials
Relationships and interactions
• Input FASTA/FASTQ files → file_io core → record tuples
• Records → container types → fed into algo::suffix_sorter → sorted indices/results
• Utility functions (istring) support parsing; logging via spdlog throughout
• Build system (CMake) pulls in submodules, compiles core + tests, generates docs
• CI triggers CMake, runs tests, builds & publishes docs
Architectural patterns & principles
• Modular layering: I/O → data structures → algorithms → utilities
• Single Responsibility: each module has a focused role
• Dependency Injection via template headers (no global state)
• Extensibility: submodule-based plugin-style dependency management
Essential elements
• Clear labels for each module and submodule
• On tooling: CMake, GitHub Actions, Doxygen