pyrokinetics.metadata.metadata

pyrokinetics.metadata.metadata(title, obj, **kwargs)

Return a dict of metadata which can be used to uniquely identify Pyrokinetics objects. Should be written to Pyrokinetics output files to establish their provenance.

Parameters:

• title (str) – A title to be assigned to the object. Recommended to use the object name if no other obvious title can be determined.

• obj (str) – The type of Pyrokinetics object, expressed as a string. It is recommended to use self.__class__.__name__ in external classes.

• **kwargs (str) – Extra keywords to add to the returned dict.

Return type:

Dict[str, str]