Version:

salvus.opt.misfits

salvus.opt.misfits salvus opt misfits
Misfits and objective functionals.

Functions

get_available_misfits()

Get a list of all available misfits.
SIGNATURE
def get_available_misfits() -> list[str]: ...
RETURNS
Return type: list[str]

get_available_misfits_and_versions()

Return a dictionary of available misfits and a list of available versions of that misfit.
SIGNATURE
def get_available_misfits_and_versions() -> dict[str, list[int]]: ...
RETURNS
Return type: dict[str, list[int]]

get_misfit_function()

Get a misfit functional.
SIGNATURE
def get_misfit_function(
    name: str, version: int | None = None
) -> typing.Callable: ...
ARGUMENTS
Required
name
Type:str
Description:
The name of the misfit functional.
Optional
version
Type:int | None
Default value:None
Description:
The version number of the misfit functional. If not given it will return the latest version.
RETURNS
Return type: typing.Callable

Submodules

PAGE CONTENTS