Eric Coissac
27f5e88a7b
Replace raw SuperkMer routing with a new RoutableSuperKimer type that embeds canonical sequences and precomputed minimizers, enabling direct partition routing via hash. Update the build pipeline to yield RoutableSuperKmers throughout (builder, scatterer), refactor FASTA/unitig export commands to use the new type and compressed outputs (.fasta.gz, .unitigs.fasta.zst), revise SuperKmer header to store n_kmers instead of seql (avoiding 256-byte wrap), and update documentation to reflect minimizer-based theory, two evidence-encoding strategies for unitig-MPHF indexing (global offset vs. ID+rank), and the new obipipeline library architecture with parallel workers, biased scheduling, and error handling.
53 lines
1.3 KiB
YAML
53 lines
1.3 KiB
YAML
site_name: obikmer
|
|
docs_dir: docmd
|
|
site_dir: doc
|
|
|
|
theme:
|
|
name: material
|
|
|
|
plugins:
|
|
- mermaid2:
|
|
- bibtex:
|
|
bib_file: docmd/references.bib
|
|
csl_file: docmd/ecology-letters.csl
|
|
enable_inline_citations: false
|
|
|
|
markdown_extensions:
|
|
- admonition
|
|
- footnotes
|
|
- tables
|
|
- pymdownx.superfences:
|
|
custom_fences:
|
|
- name: mermaid
|
|
class: mermaid
|
|
format: !!python/name:pymdownx.superfences.fence_code_format
|
|
- pymdownx.arithmatex:
|
|
generic: true
|
|
|
|
extra_javascript:
|
|
- https://unpkg.com/mathjax@3/es5/tex-mml-chtml.js
|
|
|
|
nav:
|
|
- Home: index.md
|
|
- Theory:
|
|
- Kmers and super-kmers: kmers.md
|
|
- DNA encoding: theory/encoding.md
|
|
- Entropy filter: theory/entropy.md
|
|
- Minimizer selection: theory/minimizer.md
|
|
- Partitioning architecture: theory/indexing.md
|
|
- Implementation:
|
|
- SuperKmer: implementation/superkmer.md
|
|
- Kmer: implementation/kmer.md
|
|
- Chunk reader: implementation/chunkreader.md
|
|
- Construction pipeline: implementation/pipeline.md
|
|
- obipipeline library: implementation/obipipeline.md
|
|
- On-disk storage: implementation/storage.md
|
|
- MPHF selection: implementation/mphf.md
|
|
- Unitig evidence encoding: implementation/unitig_evidence.md
|
|
- Architecture:
|
|
- Sequences: architecture/sequences/invariant.md
|
|
|
|
watch:
|
|
- docmd
|
|
- mkdocs.yml
|