load_example

bapsf_motion.utils.load_example(filename: str, as_string=False)

Load an example TOML file from bapsf_motion.examples.

Parameters:

  • filename (str) – Name of the example file, including extension.

  • as_string (bool, optional) – If True, then return the example configuration as a TOML string; otherwise, return the configuration as a dictionary. (DEFAULT:False)

Returns:

config – Return the example configuration.

Return type:

dict or str