API reference¶
Auto-generated from the in-source docstrings via mkdocstrings. Modules are grouped by role:
| Module | Role |
|---|---|
halocat.config |
paths, the simulation grid, default binning |
halocat.io |
catalogue and HDF5 read/write |
halocat.hmf |
halo mass function measurement |
halocat.tpcf |
halo–halo 2PCF measurement |
halocat.velocity |
pairwise velocity moments |
halocat.pipeline |
full-pipeline orchestration |
halocat.dataloader |
load-or-measure data loaders + records |
halocat.utils |
logging, timer, directory helpers |
Private members (anything starting with _) are filtered out by
default. To inspect them, use pydoc halocat.<module> from the shell.