nessai.utils.settings

Utilities for determining the settings available in nessai.

Used for bilby and pycbc-inference.

Module Contents

Functions

get_all_kwargs(→ dict)	Get a dictionary of all possible kwargs and their default values.
get_run_kwargs_list(→ List[str])	Get a list of kwargs used in the run method

nessai.utils.settings.get_all_kwargs(importance_nested_sampler: bool = False, split_kwargs: bool = False) → dict

Get a dictionary of all possible kwargs and their default values.

Parameters:

importance_nested_sampler

Indicates whether the importance nested sampler will be used or not. Defaults to False for backwards compatibility.

split_kwargs

If True, the kwards are split into kwargs passed to FlowSampler and those passes to FlowSampler.run. If False, all kwargs are return in a single dictionary.

Returns:

Dictionary of kwargs and their default values.

nessai.utils.settings.get_run_kwargs_list(importance_nested_sampler: bool = False) → List[str]

Get a list of kwargs used in the run method

Parameters:

importance_nested_sampler

Indicates whether the importance nested sampler will be used or not. Defaults to False for backwards compatibility.

Returns:

List of kwargs.