pyprobe.readme_processor module

Module for processing PyPrBE README files.

class ReadmeModel(readme_dict)

Bases: object

A class for processing the README.yaml file.

Parameters:

readme_dict (Dict[str, Any])

process_readme(readme_path)

Function to process the README.yaml file.

Parameters:

readme_path (str) – The path to the README.yaml file.

Returns:

Tuple[List[str], List[List[int]], Optional[pybamm.Experiment]]

• List[str]: The list of titles from the README.yaml file.

• List[List[int]]: The list of steps from the README.yaml file.

• Optional[pybamm.Experiment]: The PyBaMM experiment object.

Return type:

ReadmeModel