Logo

Getting started

  • Installation
  • Quickstart

User guide

  • Nuts and bolts
  • Anatomy of a simulation
  • Founder data
  • Recombination maps
  • Phenogenetic architectures
  • Mating regimes
  • Statistics
  • Post-processing
  • Advanced genetic architectures

Guides (New)

  • Guides

API Reference (New)

  • API Reference

Example Notebooks

  • Simple Simulation
  • Bivariate Assortative Mating
  • Vertical Transmission
  • GWAS and PGS
  • Checkpoint and Resume
  • Sibling Effects
  • GRG Genotypes

API reference (Legacy)

  • Submodule organization
  • arch module
  • effect module
  • founders module
  • index module
  • io module
  • mate module
  • ped module
  • reproduce module
  • sim module
  • stats module
  • struct module
  • utils module
xftsim
  • Search

© Copyright 2024-2026, Richard Border.

Built with Sphinx using a theme provided by Read the Docs.