binny.nz.registry module

Registry for named redshift-distribution models.

This module maps string model names (e.g. “smail”, “gaussian”) to callables that evaluate redshift distributions n(z) on a provided redshift grid.

The registry provides: - Discovery via available_models - Lookup via get_model - Convenience evaluation via nz_model

binny.nz.registry.available_models() → list[str]

Lists the supported redshift-distribution model names.

Returns:

A sorted list of registry keys that can be passed to get_model or nz_model.

binny.nz.registry.get_model(name: str) → DistFunc

Gets a registered redshift-distribution model by name.

Parameters:

name – Model name (case-insensitive). Must be one of available_models().

Returns:

The callable model associated with name.

Raises:

ValueError – If name is not a known model key.

binny.nz.registry.nz_model(name: str, z: Any, /, **params: Any) → ndarray[tuple[Any, ...], dtype[float64]]

Evaluates a named redshift-distribution model on a redshift grid.

This is a convenience wrapper around get_model that also ensures z and the returned array are np.float64.

Parameters:

• name – Model name (case-insensitive). Must be one of available_models().

• z – Redshift grid. Any array-like input accepted by np.asarray.

• **params – Model-specific keyword parameters forwarded to the model.

Returns:

The model evaluated on z as a float64 NumPy array with the same shape as z.

Raises:

ValueError – If name is not a known model key.