Source code for abm_colony_collection.calculate_centrality_measures

import networkx as nx
import pandas as pd


def calculate_centrality_measures(network: nx.Graph) -> pd.DataFrame:
    """
    Calculate centrality measures for each node in network.

    Measures include:

    - Degree centrality = quantifies how many neighbors a node has
    - Closeness centrality = quantifies how close a node is to all other nodes
      in the network
    - Betweenness centrality = quantifies the extent to which a vertex lies on
      shortest paths between other vertices

    Parameters
    ----------
    network
        The network object.

    Returns
    -------
    :
        Centrality measures for each node in the network.
    """

    # Calculate different centrality measures for network.
    degree_centralities = nx.degree_centrality(network)
    closeness_centralities = nx.closeness_centrality(network)
    betweenness_centralities = nx.betweenness_centrality(network)

    # Extract centrality measures for each node in network.
    measures = [
        {
            "ID": node,
            "DEGREE_CENTRALITY": degree_centralities[node],
            "CLOSENESS_CENTRALITY": closeness_centralities[node],
            "BETWEENNESS_CENTRALITY": betweenness_centralities[node],
        }
        for node in network.nodes
    ]

    return pd.DataFrame(measures)