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.26.4 (the core library). The Python tabs document pygenogrove 0.9.2 (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 or pygenogrove (see Installation)

  • For C++: a C++20 compatible compiler (GCC 13+, Clang 16+, Apple Clang 15+). For Python: Python 3.10–3.14 and pip install pygenogrove; the published wheels need no compiler or htslib (a source build does — see the installation page).

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

Guide Contents#

Start with Installation and Grove (create a grove, insert, query), then Loading Data from Files to fill it from a file and Graph Overlay to link keys. Complete Examples has complete programs. The remaining pages are reference-style and can be read as needed.

Next Steps#