API Reference

This section documents the public API of the refactored xftsim modules. These are the n* modules that replace the legacy architecture.

Module

Description

Simulation

Forward-time simulation loop (Simulation)

Architecture & Components

Architecture DAG, components, and nodes

Effects

Genetic effect specifications (EffectSpec, AdditiveEffects, etc.)

Mating

Mate assignment (RandomMating, LinearAssortativeMating)

Filters

Filters and filtered views (trios, sib-pairs)

Statistics

Per-generation statistics

GWAS & Polygenic Scores

GWAS and polygenic scores

I/O

Serialization and I/O

Core Data Structures

Core data structures (HaplotypeOperator, PhenotypeArray, etc.)

Formula Parser

Formula DSL parser

CLI Reference

Command-line interface