neighbormodels.interactions.compute_interaction_signs

compute_interaction_signs(magnetic_patterns_df: pandas.core.frame.DataFrame) → pandas.core.frame.DataFrame[source]

Computes the signs of the pairwise interactions for the magnetic model.

Parameters:magnetic_patterns_df – A pandas DataFrame labeling and specifying magnetic patterns.
Returns:A pandas DataFrame of the signs of the pairwise interactions.