Workflows

Collections of pre-defined workflows for common tasks. All of the workflows implement a fit_plot_save function which typically takes in the data, initial guesses for parameters, and other optional arguments, and saves the fitted parameters and plots of the fit.

ionworkspipeline.workflows.half_cell_ocp.fit_plot_save(electrode, data, params_to_fit, known_params, save_dir=None, filename=None, objective=None, objective_kwargs=None, datafit_kwargs=None, show_plot=False)

Fit the MSMR model to OCP data and plot and save the results.

Deprecated since version This: function has been removed. Use iwp.DataFit directly instead.

ionworkspipeline.workflows.full_cell_ocv.fit_plot_save(data, params_to_fit, known_params, save_dir=None, filename=None, objective=None, objective_kwargs=None, datafit_kwargs=None, show_plot=False)

Fit the MSMR model to full-cell OCV data and plot and save the results.

Deprecated since version This: function has been removed. Use iwp.DataFit and iwp.Pipeline directly instead.

ionworkspipeline.workflows.current_driven.fit_plot_save(data, params_to_fit, known_params, save_dir=None, filename='', objective_kwargs=None, datafit_kwargs=None, show_plot=False)

Fit parameters to current-driven data, plot results, and save outputs.

Deprecated since version This: function has been removed. Use iwp.DataFit directly instead.

The workflows call the following common methods, which can be used to create new workflows:

ionworkspipeline.workflows.common.get_objective_and_callbacks(data, objective, save_dir=None, objective_kwargs=None)

Get objective and callbacks for a workflow.

Deprecated since version This: function has been removed. Set up objectives and callbacks directly.

ionworkspipeline.workflows.common.process_filename(filename)

Process the filename for saving results.

Deprecated since version This: function has been removed.

ionworkspipeline.workflows.common.plot(data_fit, save_dir=None, filename='', show_plot=False)

Plot the results of the data fit for all objectives.

Deprecated since version This: function has been removed. Call data_fit.plot_trace() and callback plotting methods directly.