postprocess_orderings¶
- atomate2.common.jobs.magnetism.postprocess_orderings(tasks_metadata_uuids)[source]¶
Identify ground state ordering and build summary document.
This job performs the same analysis as that performed by the MagneticOrderingsBuilder. It is provided here for convenience and runs automatically at the conclusion of a successful MagneticOrderingsFlow.
- Parameters:
tasks_metadata_uuids (list[tuple[TaskDoc, dict, str]]) – A list of tuples containing the output task document, metadata, and uuid for each job. This format is used to construct a dict that mimics how job data is stored and provided to the builder input.
build_doc_fn (Callable[[list[dict]], MagneticOrderingsDocument]) – A function to build the summary document from a list of dicts.
- Returns:
A summary document containing the ground state ordering and other information.
- Return type: