API Reference

This section documents gwmock-pop with mkdocstrings for Python (via Zensical). Source paths are under src/gwmock_pop/.

Entry points¶

Page	Scope
Package	Symbols re-exported from `gwmock_pop` (`GWPopSimulator`, simulators, loaders, `validate_sample`, `list_presets`, …)
Version	`__version__`

Page	Scope
CLI overview	`gwmock_pop.cli` package
Main	Typer app, logging, `--version`
Simulate	`--config`, `--n`, `--output`, `--seed`
Convert	CSV ↔ HDF5 catalogue conversion, `--column-map`
Validate	Graph config validation without sampling
Inspect	Quick population summaries
List	Packaged presets and public simulator classes

Page	Scope
Protocols overview	`gwmock_pop.protocols`
GWPopSimulator	Population simulator protocol
ExternalPopulationLoader	File-backed loader protocol
Loaders	`FilePopulationLoader`, `read_population_catalogue`, …
Population validation	`validate_sample` and catalogue checks
Graph validation	`validate_graph_config`, `ValidationReport`

Page	Scope
Configuration overview	Pydantic run/population/output models
Presets	Packaged YAML/TOML presets (`list_presets`, `get_packaged_preset`, …)

Page	Scope
Simulators overview	`GraphSimulator`, `CBCSimulator`, `BBHSimulator`, `BNSSimulator`, `NSBHSimulator`, `MixtureSimulator`, `PoissonEventSampler`
Graph simulator	Config-driven `GraphSimulator`
Simulator base	`Simulator` ABC
CBC simulators	`CBCSimulator`, `BBHSimulator`, `BNSSimulator`, `NSBHSimulator` — graph-backed CBC prior simulators

Page	Scope
Graph utilities	Build, sampler/transform dependency extraction; see also config validation
Graph build	`build_dependency_graph`
Transforms	`luminosity_distance_to_redshift`, `multiply`, …
Samplers	JAX sampling functions used in graph configs
Distributions	PDFs / CDFs used by samplers

Section	Overview page
Cosmology	Flat ΛCDM distance helpers
Conversion	CBC parameter conversions
Parameters	Typed parameter records (e.g. BBH)
RNG	`RNGManager`
Integrators	Quadrature helpers
Utilities	YAML, logging, dynamic imports

Use the left navigation for the full tree (including per-module detail pages under each overview).