neighbormodels.interactions.aggregate_interaction_coefficients¶
-
aggregate_interaction_coefficients
(data_frame: pandas.core.frame.DataFrame, num_sites: int) → pandas.core.frame.DataFrame[source]¶ Aggregates interaction coefficients by summing them within groups defined by the magnetic patterns and interaction parametres. Compatible with the pandas
pipe()
method.Parameters: - data_frame – A pandas
DataFrame
of interaction coefficients and parameters grouped by magnetic patterns, subspecies pairs, and neighbor distances. - num_sites – The total number of magnetic sites in the unit cell.
Returns: A data frame where the interaction coefficients were summed within groups defined by the magnetic patterns and interaction parameters.
- data_frame – A pandas