CLI Reference

Command-line interface for running simulations, resuming from checkpoints, inspecting checkpoint data, and running built-in demos.

Usage:

xftsim run config.yaml
xftsim resume checkpoint_dir/
xftsim info checkpoint_dir/
xftsim demo UGRM

Command-line interface for xftsim.

Provides commands for running simulations, resuming from checkpoints, inspecting checkpoint data, and running built-in demos.

Usage:: xftsim run config.yaml xftsim resume checkpoint_dir/ xftsim info checkpoint_dir/ xftsim demo UGRM
To install as a console script, add to setup.py / pyproject.toml:: [project.scripts] xftsim = “xftsim.cli:app”

xftsim.cli.build_simulation_from_config(config)[source]

Build an Simulation from a parsed config dict.

Parameters:: config (dict) – Configuration dictionary with keys: founder, effects, architecture, mating, simulation. Optional: recombination, statistics, filters, output.
Returns:: tuple[Simulation, dict] – The configured simulation and output settings dict.
Raises:: ValueError – On invalid configuration.
Parameters:: config (dict)

xftsim.cli.run(config_path=<typer.models.ArgumentInfo object>, generations=<typer.models.OptionInfo object>, seed=<typer.models.OptionInfo object>, output_dir=<typer.models.OptionInfo object>, checkpoint_every=<typer.models.OptionInfo object>, plain=<typer.models.OptionInfo object>, rich_flag=<typer.models.OptionInfo object>, quiet=<typer.models.OptionInfo object>, verbose=<typer.models.OptionInfo object>)[source]

Run a simulation from a YAML/JSON config file.

Parameters:

config_path (str)
generations (Optional[int])
seed (Optional[int])
output_dir (Optional[str])
checkpoint_every (Optional[int])
plain (bool)
rich_flag (bool)
quiet (bool)
verbose (bool)

xftsim.cli.resume(checkpoint_dir=<typer.models.ArgumentInfo object>, generations=<typer.models.OptionInfo object>, output_dir=<typer.models.OptionInfo object>, checkpoint_every=<typer.models.OptionInfo object>, plain=<typer.models.OptionInfo object>, rich_flag=<typer.models.OptionInfo object>, quiet=<typer.models.OptionInfo object>, verbose=<typer.models.OptionInfo object>)[source]

Resume a simulation from a checkpoint directory.

Parameters:

checkpoint_dir (str)
generations (int)
output_dir (Optional[str])
checkpoint_every (Optional[int])
plain (bool)
rich_flag (bool)
quiet (bool)
verbose (bool)

xftsim.cli.info(checkpoint_dir=<typer.models.ArgumentInfo object>, plain=<typer.models.OptionInfo object>, rich_flag=<typer.models.OptionInfo object>, quiet=<typer.models.OptionInfo object>)[source]

Show info about a checkpoint or saved simulation.

Parameters:

checkpoint_dir (str)
plain (bool)
rich_flag (bool)
quiet (bool)

xftsim.cli.demo(name=<typer.models.ArgumentInfo object>, n=<typer.models.OptionInfo object>, m=<typer.models.OptionInfo object>, generations=<typer.models.OptionInfo object>, seed=<typer.models.OptionInfo object>, plain=<typer.models.OptionInfo object>, rich_flag=<typer.models.OptionInfo object>, quiet=<typer.models.OptionInfo object>, verbose=<typer.models.OptionInfo object>)[source]

Run a built-in demo simulation.

Parameters:

name (str)
n (int)
m (int)
generations (int)
seed (int)
plain (bool)
rich_flag (bool)
quiet (bool)
verbose (bool)

xftsim.cli.main()[source]: Entry point for console_scripts.