Mondaic

salvus.opt.misfits

salvus.opt.misfits salvus opt misfits

Misfits and objective functionals.

Functions

get_available_misfits()

def get_available_misfits() -> list[str]: ...

Get a list of all available misfits.

Returns list[str]

get_available_misfits_and_versions()

def get_available_misfits_and_versions() -> dict[str, list[int]]: ...

Return a dictionary of available misfits and a list of available versions of that misfit.

Returns dict[str, list[int]]

get_misfit_function()

def get_misfit_function(
    name: str, version: int | None = None
) -> typing.Callable: ...

Get a misfit functional.

Parameters
  • name str — The name of the misfit functional.
  • version int | None — The version number of the misfit functional. If not given it will return the latest version.
Returns typing.Callable

Submodules