User Guide

This user guide provides comprehensive coverage of genogrove’s functionality, from reading genomic files to building complex data structures and queries.

Every topic below is documented with side-by-side C++ and Python tabs — pick a language once and the choice follows you across all pages.

Note

The C++ tabs document genogrove 0.25.3 (the core library). The Python tabs document pygenogrove 0.7.0 (the bindings), which version independently and may not yet expose every C++ feature. Each tab label shows the version it reflects.

Prerequisites

Before starting, ensure you have:

• Installed genogrove (see genogrove for installation instructions)

• A C++20 compatible compiler (GCC 13+, Clang 16+, Apple Clang 15+)

• Basic familiarity with genomic file formats (BED, GFF/GTF)

Guide Contents

• Installation
• Reading Genomic Files (I/O)
• Working with Data Types
  • Key
  • Registry
• Grove
  • Linking Keys
  • Graph Manipulation
  • Loading Data from Files
• Serialization
• Thread Safety
• Complete Examples
• Performance Optimization

Next Steps

• Explore the full API Reference for detailed API documentation

• Check the examples directory in the repository

• Learn about advanced features in the project wiki

• Join the community discussions on GitHub