relentless.model.potential.Parameters

class relentless.model.potential.Parameters(types, params)

Parameters for types.

Each type is a str. A named list of parameters can be set for type.

Parameters:

• types (tuple[str]) – Types.

• params (tuple[str]) – Required parameters.

Raises:

• ValueError – If params is empty.

• TypeError – If params is not only strings.

Methods

evaluate(key)	Evaluate parameters.
from_json(data)
to_json()	Export parameters to a JSON-compatible dictionary.

evaluate(key)

Evaluate parameters.

Parameters:

key (str) – Key for which the parameters are evaluated.

Returns:

params – The evaluated parameters.

Return type:

dict

to_json()

Export parameters to a JSON-compatible dictionary.

Returns:

Evaluated parameters.

Return type:

dict