pmutt.io.omkm.organize_phases
- pmutt.io.omkm.organize_phases(phases_data, species=None, reactions=None, interactions=None)
Helper method to organize phase data for OpenMKM
- Parameters:
phases_data (list of dict) – Each element of the list corresponds to the data to initialize the phase. Each dictionary are keyword arguments.
species (list of
Nasa
,Nasa9
and/orShomate
objects, optional) – Species with phases to include. Default is None.reactions (list of
SurfaceReaction
objects, optional) – Reactions occuring on phases to include. Default is None.interactions (list of
PiecewiseCovEffect
objects, optional) – Lateral interactions to include. Default is None
- Returns:
phases – Phases organized using parameters.
- Return type:
list of
Phase
objects