build_magnetism_docs

emmet.builders.materials.magnetism.build_magnetism_docs(input_documents, **kwargs)

Generate magnetism documents from input structures.

Transforms a list of MagnetismBuilderInput documents containing Pymatgen structures into corresponding MagnetismDoc instances by analyzing the magnetic configuration of each structure.

Caller is responsible for creating MagnetismBuilderInput instances within their data pipeline context.

Return type:

Iterator[MagnetismDoc]

Parameters:

input_documents (list[MagnetismBuilderInput])

Args:

input_documents: List of MagnetismBuilderInput documents to process.

Returns:

Iterator[MagnetismDoc]