jaxrts.collections.get_all_models

jaxrts.collections.get_all_models(types: list[Literal['models', 'hnc_potentials']], names_only: Literal[False] = False) → dict[str, list[Model | HNCPotential]]

jaxrts.collections.get_all_models(types: list[Literal['models', 'hnc_potentials']], names_only: Literal[True]) → dict[str, list[str]]

Get a dictionary of all jaxrts.models.Model defined within jaxrts that are valid to attach to a jaxrts.plasma_state.PlasmaState. The allowed_keys are the key of the returned dictionary.

Parameters:

• types (List[Literal["models", "hnc_potentials"]]) – default [“models”, “hnc_potentials”]. Which types of models should be included.

• names_only (bool, default False) – If true, the values of the returned dict are a list of jaxrts.models.Model object. If false, the values are rather list of strings with of the name of the models.

Returns:

• Dictionary of keys and lists of either models or model-names that are

• implemented in jaxrts.