Mondaic
This API reference is not for the latest stable Salvus version.

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: Optional[int] = None) -> Callable:
    ...

Get a misfit functional.

Parameters
  • name str — The name of the misfit functional.
  • version Optional[int] — The version number of the misfit functional. If not given it will return the latest version.
Returns Callable

Submodules