Skip to content

Upstream inventory

Snapshot inspected on 2026-08-25. Commits are research references, not Cargo dependency pins unless explicitly listed in Cargo.lock.

ProjectRepositoryVersion / inspected commitLicensePurpose
GBZ-basehttps://github.com/jltsiren/gbz-base0.6.1 / a5ed1ff3ddc402e230d1187afa438e05c8b3654eMITResearch SQLite baseline, independent query oracle, fixture source; not the production encoder
GBWT-rs / gbzhttps://github.com/jltsiren/gbwt-rscrate 0.7.0 / a0d72bc3bd261fc433e59de64b2706f5f45708adMITRust GBZ parser and graph API
GBWTGraphhttps://github.com/jltsiren/gbwtgraphe27bc439cf110ac8cca89fcecacda993d2c9df70MITGBZ v3 / GBWTGraph v4 serialization reference
GBWThttps://github.com/jltsiren/gbwtc2e0199694fe41ec46c61c201c6ae0cd7dd08783MITCompressed haplotype index implementation/serialization
vghttps://github.com/vgteam/vgac5822f8d22a80df02f7c101aa90914d1bce0cfdMIT (repository; contrib/submodules vary)Producer/tooling and fixture provenance
vg Snakemakehttps://github.com/vgteam/vg_snakemaked938c2035fa5ce16acd69147743762b513292173GPL-3.0Medium MHC Minigraph-Cactus GBZ fixture and construction provenance
HPRC resourceshttps://github.com/human-pangenomics/hpp_pangenome_resourcescd99ffb2fbddd2d5bd91f4483065a44bfe83b287No repository license found; HPRC Data Use Protocol appliesCurrent v2.1 object list and data caveats
PMTileshttps://github.com/protomaps/PMTiles182d5b3cfdc2f5a6adbc54630c612da2f6086bddSpec CC0; reference implementations BSD-3-ClauseRange-oriented single-object directory analogy
COG spechttps://github.com/cogeotiff/cog-spec203241975d054e5c933493f65bc4810e93d0048aCC BY 4.0Ordered metadata/overview/block analogy

Cargo dependencies

Direct dependencies are constrained in the workspace manifest and exactly resolved by Cargo.lock:

  • gbz = 0.7.0
  • gbz-base = 0.6.1
  • simple-sds = 0.4.2
  • blake3 = 1.8.7 (resolved from the compatible 1.8.2 requirement)
  • serde = 1.0.229 and serde_json = 1.0.151
  • sha2 = 0.10.9
  • zstd = 0.13.3

GBZ 0.7.0 itself uses simple-sds 0.4.2 and zstd 0.13.3 in this lockfile.

Bounded source access and remaining upstream opportunity

The normal encoder no longer calls simple_sds::serialize::load_from or gbz-base. DiskGbzSource parses the locked GBZ/simple-sds serialization, streams record and sequence bodies to temporary disk, and supplies project-owned reference indexing and local context extraction. On the 5,492,627,216-byte HPRC source, the final whole encode fell from 8,775,928 to 608,060 KiB peak RSS and remained byte-identical. Whole wall increased from 438.72 to 499.34 seconds and the disk-backed path used an 11,921,858,427-byte ephemeral cache.

A focused upstream issue remains useful in UPSTREAM_LAZY_GBZ_ACCESS.md. It asks for an official borrowed/mmap or section-lazy API so this repository does not have to track upstream serialization details. It is now an interoperability and maintenance improvement, not a blocker for bounded production encoding.

Named-path research still exposes an upstream opportunity, but it is no longer a local dependency. The local /home/ard/projects/gbwt-rs fork established the exact four-structure DA interpretation and bounded ordinary-locate oracle. The build crate now contains a focused construction-only implementation using the released gbz and simple-sds crates. Tiny, rice, and bounded HPRC direct encoder outputs are byte-identical to the fork/C++ prepared fixtures. Persistent source-cache v2 retains authenticated DA structures and the canonical path catalog. An upstream borrowed or owned locate API would reduce local serialization maintenance; it is not required by the encoder or decoder.

JavaScript benchmark dependencies

The private benchmark package uses fzstd 0.1.1 (MIT) through the public reader as its default pure-JavaScript decoder, @bokuweb/zstd-wasm 0.0.27 (MIT) as the optional decoder comparison, and Playwright 1.62.1 (Apache-2.0) for real-browser execution. The WASM package is benchmark-only and is not exported by or selected as the default decoder in the public reader.

Fixture provenance and terms

micb-kir3dl1.gbz is fetched from the pinned GBZ-base commit above. The GBZ-base repository is MIT licensed; its README identifies the fixture as an HPRC Minigraph-Cactus v1.1 subset also used by vg's haplotype-sampling tests. The fixture is not committed here. The fetch script verifies SHA-256 1d574ede7533150eb87f6837a7763d4eac120aa03f34877392ecdd53b0410788.

Before distributing that binary or derived datasets, re-check the upstream license/provenance and applicable HPRC Data Use Protocol. HPRC v2.1 resources in particular are currently described upstream as not fully QC'd, unpublished, and potentially containing known issues.

mhc-10.gbz is fetched from the pinned vg Snakemake commit above. Its upstream README says it was built with Minigraph-Cactus from 10 haplotypes selected from Heng Li's MHC-61 dataset, Zenodo DOI https://doi.org/10.5281/zenodo.6617246. The fetch script verifies a size of 4,511,832 bytes and SHA-256 a0b44236852d5659202a6855308020df05efd7c2be90645d341d94fb775df685. This small medium-scale fixture is intentionally committed for hermetic research tests. Re-check the source record's license and HPRC data-use terms before redistributing it or derived archives outside this repository.

Literature