Utilities

ionworkspipeline.util.subplots_autolayout(n, *args, n_rows=None, figsize=None, layout='constrained', **kwargs)

Create a subplot element with a

ionworkspipeline.util.export_python_script(parameter_values, filename, data_path=None)

Print a python script that can be used to reproduce the parameter set

Parameters

parameter_valuespybamm.ParameterValues

The parameter valyes to export

filenamestring

The name to save the parameter set under

data_pathstring, optional

The path to the where to look for data, e.g. when loading using PyBaMM’s process_parameter_data functions. If None, then data will be looked for in the same directory as the exported file. Default is None.

ionworkspipeline.util.save_csv(df, folder, file)

Save df to a csv file in folder/file

Parameters

dfpandas.DataFrame or dict

DataFrame to save.

folderstr

Folder to save file in. This folder will be created if it does not exist

filestr

File name

ionworkspipeline.util.save_json(params, folder, file)

Save params to a json file in folder/file

Parameters

paramsdict

Dictionary of parameters

folderstr

Folder to save file in. This folder will be created if it does not exist

filestr

File name

ionworkspipeline.util.save_fig(fig, folder, file)

Save fig to a file in folder

Parameters

figmatplotlib.figure.Figure

Figure to save

folderstr

Folder to save file in. This folder will be created if it does not exist

filestr

File name