neighbormodels.interactions.build_magnetic_patterns_data_frame¶
-
build_magnetic_patterns_data_frame
(magnetic_patterns: Dict[str, Union[int, float]]) → pandas.core.frame.DataFrame[source]¶ Converts dictionary of magnetic patterns into the pandas
DataFrame
format.Parameters: magnetic_patterns – A dictionary of magnetic patterns to be mapped onto the crystal structure and used to compute the interaction coefficients of the model. Returns: A pandas DataFrame
labeling and specifying magnetic patterns.