Welcome to stdgrimmsim

Population genetic simulations for German folklore and mythology.

stdgrimmsim is a library of demographic and genome models for beings from German folklore, fairy tales (Grimm), and regional mythology. Simulate dwarves, water spirits (Nix), Rübezahl, Frau Holle, the Loreley, and Black Forest spirits with made-up but population-genetically plausible parameters — powered by msprime and SLiM and built on the stdpopsim framework.

Es war einmal … — Grimms’ Fairy Tales

First steps

• Install: Installation — get stdgrimmsim on your machine.

• Explore: Catalog — 32 species and 150 demographic models.

• Run: Tutorial — examples and workflows.

Quick run

Install and simulate 10 mountain dwarf samples over 100 kb:

$ pip install stdgrimmsim
$ stdgrimmsim ZweBerg -d BlackForest_1D12 -o dwarves.trees -L 100000 BlackForest:10

Then open dwarves.trees in tskit or continue with the tutorial.

Catalog at a glance

The full catalog lists every species and demographic model. By category:

• Fairy tale & Grimm - Zwergus bergensis (mountain dwarf), Holle hesseensis (Frau Holle)

• Water & river spirits - Nixus rhenanus (Nix), Loreley rhenanus (Loreley)

• Mountain & regional mythology - Ruebezahl harzensis (Rübezahl), Silvani schwarzwaldensis (Black Forest spirit)

• Generic models - Generic demographic models (any species)

Contents:

• Introduction
  • First steps
  • Citations
  • Licence and usage
• Installation
  • Requirements
  • Conda
  • Pip
  • Running the CLI
• Catalog
  • Fairy tale & Grimm
  • Water & river spirits
  • Forest & nocturnal spirits
  • Mountain & regional mythology
  • Shape-shifters & mythical beasts
  • Generic models
• All demographic models
• Tutorials
  • Running stdgrimmsim with the command-line interface (CLI)
  • Running stdgrimmsim with the Python interface (API)
  • Example analyses with stdgrimmsim
• Command-line options
  • Positional Arguments
  • Named Arguments
  • msprime specific parameters
  • SLiM specific parameters
  • Sub-commands
• API
  • Quick reference
  • Species definitions
  • Demographic Models
  • Gene conversion and bacterial recombination
  • Selection and DFEs
  • Selection and sweeps
  • Generic models
  • Simulation Engines
• Development
  • Installation
  • GitHub workflow
  • Adding a new species
  • Adding a new demographic model
  • Adding a recombination/genetic map or annotation
  • Lifting over a recombination/genetic map
  • Adding a DFE model
  • Coding standards
  • Naming conventions
  • Unit tests
  • Code Coverage
  • Documentation
  • Making a new release
• Changelogs
  • Upcoming
  • [0.1.0] - 2026-02-15
  • [0.3.0] - 2025-03-18
  • [0.2.1a] - 2024-07-06
  • [0.2.0] - 2022-11-01
  • [0.1.2] - 2020-05-29
  • [0.1.1] - 2020-01-02
  • [0.1.0] - 2019-12-18

Indices and tables

• Index

• Module Index

• Search Page