Logo

Overview

  • Overview
  • What is py3plex?
  • Key Use Cases
  • Multilayer Networks in 2 Minutes

Getting Started

  • Getting Started (Tutorials)
  • Installation and Setup
  • 10-Minute Tutorial
  • Common Issues and Troubleshooting

How-to Guides

  • How-to Guides
  • How to Load and Build Networks
  • Query Zoo: DSL Gallery for Multilayer Analysis
    • Overview
    • 1. Basic Multilayer Exploration
      • Query Code
      • Why It’s Interesting
      • Example Output
      • DSL Concepts Demonstrated
    • 2. Cross-Layer Hubs
      • Query Code
      • Why It’s Interesting
      • Example Output
      • DSL Concepts Demonstrated
    • 3. Layer Similarity
      • Query Code
      • Why It’s Interesting
      • Example Output
      • DSL Concepts Demonstrated
    • 4. Community Structure
      • Query Code
      • Why It’s Interesting
      • Example Output
      • DSL Concepts Demonstrated
    • 5. Multiplex PageRank
      • Query Code
      • Why It’s Interesting
      • Example Output
      • DSL Concepts Demonstrated
    • 6. Robustness Analysis
      • Query Code
      • Why It’s Interesting
      • Example Output
      • DSL Concepts Demonstrated
    • 7. Advanced Centrality Comparison
      • Query Code
      • Why It’s Interesting
      • Example Output
      • DSL Concepts Demonstrated
    • 8. Edge Grouping and Coverage
      • Query Code
      • Why It’s Interesting
      • Example Output
      • DSL Concepts Demonstrated
    • Using the Query Zoo
      • Getting Started
      • Adapting Queries to Your Data
      • Datasets
    • Further Reading
  • How to Compute Network Statistics
  • How to Run Community Detection on Multilayer Networks
  • How to Simulate Multilayer Dynamics
  • How to Run Random Walk Algorithms
  • How to Export and Serialize Networks
  • How to Visualize Multilayer Networks
  • How to Query Multilayer Graphs with the SQL-like DSL
  • How to Find Graph Patterns and Motifs with the Pattern Matching API
  • How to Build Analysis Pipelines with Dplyr-style Operations
  • How to Reproduce Common Analysis Workflows

Concepts & Explanations

  • Concepts & Explanations
  • Multilayer Networks 101
  • The py3plex Core Model
  • Design Principles
  • Algorithm Landscape

API & DSL Reference

  • API & DSL Reference
  • Algorithm Roadmap
  • DSL Reference
  • Layer Set Algebra
  • Uncertainty-First Statistics
  • API Documentation
  • Configuration & Environment

Examples & Recipes

  • Examples & Recipes
  • Analysis Recipes & Workflows
  • Use Cases & Case Studies

Project Info

  • Project Info
  • Changelog
  • Roadmap & Vision
  • Contributing to py3plex
  • Benchmarking & Performance
  • Citation and References

Deployment & GUI

  • Environments & Deployment
  • Docker Usage Guide
  • Performance and Scalability Best Practices
  • GUI: Web Interface for Network Exploration
  • Py3plex GUI

Developer Docs

  • Developer & Contributor Docs
  • Development Guide
  • Architecture and Design
py3plex
  • Query Zoo: DSL Gallery for Multilayer Analysis
  • View page source

Query Zoo: DSL Gallery for Multilayer Analysis

The Query Zoo is a curated gallery of DSL queries that demonstrate the expressiveness and power of py3plex for multilayer network analysis.

Each example:

  • Solves a real multilayer analysis problem

  • Uses the DSL end-to-end with idiomatic patterns

  • Produces concrete, reproducible outputs

  • Is fully tested and documented

Why a Query Zoo?

The DSL is most powerful when you see it in action on realistic problems. This gallery shows you how to think about multilayer queries, not just what the syntax is. Use these examples as recipes and starting points for your own analyses.

  • Overview

  • 1. Basic Multilayer Exploration

    • Query Code

    • Why It’s Interesting

    • Example Output

    • DSL Concepts Demonstrated

  • 2. Cross-Layer Hubs

    • Query Code

    • Why It’s Interesting

    • Example Output

    • DSL Concepts Demonstrated

  • 3. Layer Similarity

    • Query Code

    • Why It’s Interesting

    • Example Output

    • DSL Concepts Demonstrated

  • 4. Community Structure

    • Query Code

    • Why It’s Interesting

    • Example Output

    • DSL Concepts Demonstrated

  • 5. Multiplex PageRank

    • Query Code

    • Why It’s Interesting

    • Example Output

    • DSL Concepts Demonstrated

  • 6. Robustness Analysis

    • Query Code

    • Why It’s Interesting

    • Example Output

    • DSL Concepts Demonstrated

  • 7. Advanced Centrality Comparison

    • Query Code

    • Why It’s Interesting

    • Example Output

    • DSL Concepts Demonstrated

  • 8. Edge Grouping and Coverage

    • Query Code

    • Why It’s Interesting

    • Example Output

    • DSL Concepts Demonstrated

  • Using the Query Zoo

    • Getting Started

    • Adapting Queries to Your Data

    • Datasets

  • Further Reading

Overview

The Query Zoo is organized around common multilayer analysis tasks:

  1. Basic Multilayer Exploration — Understand layer statistics and structure

  2. Cross-Layer Hubs — Find nodes that are important across multiple layers

  3. Layer Similarity — Measure structural alignment between layers

  4. Community Structure — Detect and analyze multilayer communities

  5. Multiplex PageRank — Compute multilayer-aware centrality

  6. Robustness Analysis — Assess network resilience to layer failures

  7. Advanced Centrality Comparison — Identify versatile vs specialized hubs

  8. Edge Grouping and Coverage — Analyze edges across layer pairs with top-k and coverage

All examples use small, reproducible multilayer networks from the examples/dsl_query_zoo/datasets.py module.

Tip

Running the Examples

All query functions are available in examples/dsl_query_zoo/queries.py. To run all queries and generate outputs:

python examples/dsl_query_zoo/run_all.py

Test the queries with:

pytest tests/test_dsl_query_zoo.py

1. Basic Multilayer Exploration

Problem: You’ve loaded a multilayer network and want to quickly understand its structure. Which layers are densest? How many nodes and edges does each layer have?

Solution: Compute basic statistics per layer using the DSL.

Query Code

def query_basic_exploration(network: Network) -> pd.DataFrame:
    """Summarize layers: node counts, edge counts, and average degree per layer.
    
    Refactored: single DSL query over all layers + pandas groupby, no explicit
    for-loop over layers.
    
    This query demonstrates basic multilayer exploration by computing
    fundamental statistics for each layer independently. This is typically
    the first step in multilayer analysis to understand the structure
    and identify layers with different connectivity patterns.
    
    Why it's interesting:
    - Reveals which layers are denser or sparser
    - Identifies layers that might be hubs of activity
    - Shows structural diversity across the multilayer network
    
    DSL concepts demonstrated:
    - SELECT nodes from all layers in one shot
    - Computing degree per layer
    - Vectorized aggregation by layer
    
    Args:
        network: A multi_layer_network instance
        
    Returns:
        pd.DataFrame with columns: layer, n_nodes, n_edges, avg_degree
    """
    result = (
        Q.nodes()
         .from_layers(L["*"])       # all layers in one shot
         .compute("degree")
         .execute(network)
    )

    if len(result) == 0:
        return pd.DataFrame(columns=["layer", "n_nodes", "n_edges", "avg_degree"])

    df = result.to_pandas()

    # One row per (node, layer), so size() is node count
    stats = (
        df.groupby("layer")
          .agg(
              n_nodes=("id", "size"),
              total_degree=("degree", "sum"),
              avg_degree=("degree", "mean"),
          )
          .reset_index()
    )

    stats["n_edges"] = (stats["total_degree"] // 2).astype(int)
    stats["avg_degree"] = stats["avg_degree"].round(2)

    return stats[["layer", "n_nodes", "n_edges", "avg_degree"]]

Why It’s Interesting

  • First step in any analysis — Before diving into complex queries, understand your data

  • Reveals layer diversity — Different layers often have vastly different structures

  • Identifies sparse vs dense layers — Helps decide which layers need special handling

Example Output

Running on the social_work_network (12 people across social/work/family layers):

Layer

Nodes

Edges

Avg Degree

social

12

11

1.83

work

11

9

1.64

family

11

6

1.09

Layer Statistics

Interpretation: The social layer is densest (highest average degree), while family is sparsest. All layers have similar numbers of nodes, indicating good cross-layer coverage.

DSL Concepts Demonstrated

  • Q.nodes().from_layers(L[name]) — Select nodes from a specific layer

  • .compute("degree") — Add computed attributes to results

  • .execute(network) — Run the query and get results

  • .to_pandas() — Convert to DataFrame for analysis


2. Cross-Layer Hubs

Problem: Which nodes are consistently important across multiple layers? These “super hubs” are critical because they bridge different contexts.

Solution: Find top-k central nodes per layer, then identify which nodes appear in multiple layers’ top lists.

Query Code

def query_cross_layer_hubs(network: Network, k: int = 5) -> pd.DataFrame:
    """Find nodes that are consistently central across multiple layers.
    
    Refactored: one DSL query across all layers + pandas grouping, no explicit
    per-layer for loop.
    
    This query identifies "super hubs" - nodes that maintain high centrality
    across different layers. These nodes are particularly important because
    they serve as connectors across different contexts or domains.
    
    Why it's interesting:
    - Reveals nodes with consistent importance across contexts
    - Useful for identifying key actors in multiplex social networks
    - Helps understand cross-layer influence and information flow
    
    DSL concepts demonstrated:
    - Single query across all layers
    - Computing betweenness centrality
    - Vectorized top-k selection per layer using groupby
    - Coverage analysis (nodes appearing in multiple layers)
    
    Args:
        network: A multi_layer_network instance
        k: Number of top nodes to select per layer
        
    Returns:
        pd.DataFrame with nodes and their centrality scores per layer
    """
    result = (
        Q.nodes()
         .from_layers(L["*"])
         .compute("betweenness_centrality", "degree")
         .execute(network)
    )

    if len(result) == 0:
        return pd.DataFrame()

    df = result.to_pandas().rename(columns={"id": "node"})

    # Top-k by betweenness within each layer (vectorized)
    df_sorted = df.sort_values(["layer", "betweenness_centrality"],
                               ascending=[True, False])
    topk = df_sorted.groupby("layer").head(k)

    # Count how many layers each node appears in as a top-k hub
    coverage = (
        topk.groupby("node")["layer"]
            .nunique()
            .reset_index(name="layer_count")
    )

    result_df = (
        topk.merge(coverage, on="node")
            .sort_values(["layer_count", "betweenness_centrality"],
                         ascending=[False, False])
    )

    return result_df[["node", "layer", "degree",
                      "betweenness_centrality", "layer_count"]]

Why It’s Interesting

  • Reveals cross-context influence — Nodes central in one layer might be peripheral in another

  • Identifies key connectors — Nodes that appear in multiple layers’ top-k are especially important

  • Robust hub detection — More reliable than single-layer centrality

Example Output

Top cross-layer hubs (k=5):

Node

Layer

Degree

Betweenness

Layer Count

Bob

social

3

0.0273

3

Bob

work

2

0.0

3

Bob

family

1

0.0

3

Alice

work

3

0.0889

2

Charlie

social

3

0.0273

2

Interpretation: Bob appears as a top-5 hub in all three layers (layer_count=3), making him the most versatile connector. Alice and Charlie are hubs in two layers each.

DSL Concepts Demonstrated

  • .compute("betweenness_centrality", "degree") — Compute multiple metrics at once

  • .order_by("-betweenness_centrality") — Sort descending (- prefix)

  • .limit(k) — Take top-k results

  • Per-layer iteration and aggregation across layers


3. Layer Similarity

Problem: How similar are different layers structurally? Do they serve redundant or complementary roles?

Solution: Compute degree distributions per layer and measure pairwise correlations.

Query Code

def query_layer_similarity(network: Network) -> pd.DataFrame:
    """Compute structural similarity between layers based on degree distributions.
    
    Refactored: single DSL query + pivot, no explicit loops over layers/nodes.
    
    This query measures how similar different layers are in terms of their
    connectivity patterns. Layers with similar degree distributions likely
    serve similar structural roles in the multilayer network.
    
    Why it's interesting:
    - Identifies redundant or complementary layers
    - Helps understand layer specialization
    - Can inform layer aggregation or simplification decisions
    
    DSL concepts demonstrated:
    - Single query across all layers
    - Pivot table to create node × layer matrix
    - Correlation between layers via .corr()
    
    Args:
        network: A multi_layer_network instance
        
    Returns:
        pd.DataFrame: Pairwise correlation matrix of layer degree distributions
    """
    result = (
        Q.nodes()
         .from_layers(L["*"])
         .compute("degree")
         .execute(network)
    )

    if len(result) == 0:
        return pd.DataFrame()

    df = result.to_pandas()

    # Build node × layer degree matrix: rows = nodes, cols = layers
    degree_matrix = df.pivot_table(
        index="id",
        columns="layer",
        values="degree",
        fill_value=0,
    )

    # Correlation between columns = correlation between layers
    corr_df = degree_matrix.corr().round(3)

    # Optional: clean up index/column names for display
    corr_df.index.name = None
    corr_df.columns.name = None

    return corr_df

Why It’s Interesting

  • Detects redundancy — High correlation suggests layers capture similar structure

  • Guides simplification — Nearly identical layers might be merged

  • Reveals specialization — Low/negative correlation shows layers serve different roles

Example Output

Correlation matrix for social_work_network:

Layer Similarity Heatmap

social

work

family

social

1.000

0.159

0.000

work

0.159

1.000

-0.267

family

0.000

-0.267

1.000

Interpretation: Social and work layers have weak positive correlation (0.159), suggesting some structural overlap. Family and work are negatively correlated (-0.267), indicating they capture different connectivity patterns.

DSL Concepts Demonstrated

  • Layer-by-layer degree computation

  • Aggregating results across layers for meta-analysis

  • Using computed attributes for layer-level comparisons


4. Community Structure

Problem: What communities exist in the multilayer network? How do they manifest across layers?

Solution: Detect communities using multilayer community detection, then analyze their distribution across layers.

Query Code

def query_community_structure(network: Network) -> pd.DataFrame:
    """Detect communities and analyze their distribution across layers.
    
    This query finds communities in the multilayer network and examines
    how they manifest across different layers. Some communities might be
    tightly connected in one layer but dispersed in others.
    
    Why it's interesting:
    - Reveals mesoscale structure in multilayer networks
    - Shows how communities span or specialize across layers
    - Useful for understanding multi-context group formation
    
    DSL concepts demonstrated:
    - Community detection via DSL
    - Grouping by community and layer
    - Aggregation and counting
    
    Args:
        network: A multi_layer_network instance
        
    Returns:
        pd.DataFrame with community info: community_id, layer, size, dominant_layer
    """
    # Compute communities across all layers
    result = (
        Q.nodes()
         .from_layers(L["*"])  # All layers
         .compute("communities", "degree")
         .execute(network)
    )
    
    if len(result) == 0:
        return pd.DataFrame()
    
    df = result.to_pandas()
    
    # Rename 'id' column to 'node' for clarity
    df = df.rename(columns={'id': 'node'})
    
    # Analyze community distribution across layers
    community_stats = df.groupby(['communities', 'layer']).agg({
        'node': 'count',
        'degree': 'mean'
    }).reset_index()
    
    community_stats.columns = ['community_id', 'layer', 'size', 'avg_degree']
    
    # Find dominant layer for each community (layer with most nodes)
    dominant = community_stats.loc[
        community_stats.groupby('community_id')['size'].idxmax()
    ][['community_id', 'layer']].rename(columns={'layer': 'dominant_layer'})
    
    # Merge dominant layer info
    result_df = community_stats.merge(dominant, on='community_id')
    
    # Sort by community size
    result_df = result_df.sort_values(['community_id', 'size'], ascending=[True, False])
    
    return result_df[['community_id', 'layer', 'size', 'avg_degree', 'dominant_layer']]

Why It’s Interesting

  • Mesoscale structure — Communities reveal organizational patterns

  • Cross-layer community tracking — See if communities are layer-specific or global

  • Dominant layers — Identify which layer best represents each community

Example Output

Running on communication_network (email/chat/phone layers):

Community

Layer

Size

Avg Degree

Dominant Layer

0

email

10

1.8

email

1

chat

6

2.17

chat

2

chat

3

1.67

chat

3

phone

7

1.71

phone

Interpretation: Community 0 is email-dominated (10 nodes), while communities 1 and 2 are chat-specific. Community 3 appears primarily in phone communication.

DSL Concepts Demonstrated

  • Q.nodes().from_layers(L["*"]) — Select from all layers

  • .compute("communities") — Built-in community detection

  • Grouping by (community_id, layer) for analysis

  • Identifying dominant layers via aggregation


5. Multiplex PageRank

Problem: Standard PageRank treats each layer independently. How do we compute importance considering the full multiplex structure?

Solution: Compute PageRank per layer, then aggregate across layers. (Note: This is a simplified version; true multiplex PageRank uses supra-adjacency matrices.)

Query Code

def query_multiplex_pagerank(network: Network) -> pd.DataFrame:
    """Approximate multiplex PageRank by aggregating layer-specific scores.
    
    NOTE: This is still a *simplified* multiplex PageRank approximation
    (average of layer-specific PageRank). For true Multiplex PageRank, wrap
    the dedicated algorithm from the algorithms module (see query_true_multiplex_pagerank).
    
    Refactored: single DSL query over all layers + vectorized pandas aggregation,
    no explicit for-loop over layers.
    
    Why it's interesting:
    - Approximates node importance across the entire multiplex
    - More informative than single-layer centralities
    - Efficient computation via aggregation
    - Good starting point before using full multiplex algorithms
    
    DSL concepts demonstrated:
    - Single query across all layers
    - Computing PageRank
    - Vectorized aggregation and pivot tables
    - Ranking nodes by multilayer importance
    
    Args:
        network: A multi_layer_network instance
        
    Returns:
        pd.DataFrame with nodes ranked by multiplex PageRank scores
    """
    result = (
        Q.nodes()
         .from_layers(L["*"])
         .compute("pagerank", "degree")
         .execute(network)
    )

    if len(result) == 0:
        return pd.DataFrame()

    df = result.to_pandas().rename(columns={"id": "node"})

    # Aggregate across layers: average PR, total degree
    multiplex_pr = (
        df.groupby("node")
          .agg(
              multiplex_pagerank=("pagerank", "mean"),
              total_degree=("degree", "sum"),
          )
          .reset_index()
    )

    multiplex_pr = multiplex_pr.sort_values("multiplex_pagerank", ascending=False)

    # Layer-specific PR breakdown as wide table
    layer_details = (
        df.pivot_table(
            index="node",
            columns="layer",
            values="pagerank",
            fill_value=0,
        )
        .round(4)
        .reset_index()
    )

    result_df = (
        multiplex_pr.merge(layer_details, on="node", how="left")
                    .round(4)
    )

    return result_df

Why It’s Interesting

  • Multilayer-aware centrality — Accounts for importance across all layers

  • More robust than single-layer — Averages out layer-specific biases

  • Essential for multiplex influence — Key for viral marketing, information diffusion

Example Output

Top nodes by multiplex PageRank in transport_network:

Node

Multiplex PR

Total Degree

Bus PR

Metro PR

Walking PR

ShoppingMall

0.1811

6

0.1362

0.1909

0.2164

Park

0.1806

4

0.1449

0.0

0.2164

CentralStation

0.1683

6

0.1971

0.1909

0.117

BusinessDistrict

0.1484

4

0.079

0.1994

0.1667

Interpretation: ShoppingMall has highest multiplex PageRank (0.1811) because it’s central across all three transport modes. Park has high walking PageRank but zero metro, reflecting its limited accessibility.

DSL Concepts Demonstrated

  • .compute("pagerank") — Built-in PageRank computation

  • Per-layer iteration with result aggregation

  • Pivot tables for layer-wise breakdowns

  • Combining degree and PageRank for richer analysis


6. Robustness Analysis

Problem: How robust is the network to layer failures? What happens if one layer goes offline?

Solution: Simulate removing each layer and measure connectivity loss.

Query Code

def query_robustness_analysis(network: Network) -> pd.DataFrame:
    """Evaluate network robustness by removing each layer and recomputing stats.
    
    This query demonstrates robustness analysis by simulating layer failure.
    For each layer, we measure how connectivity changes if that layer is removed.
    This reveals which layers are critical for network cohesion.
    
    Note: The loop over layers is semantically part of the experiment design
    (each iteration is a different scenario), which is an acceptable use of loops.
    
    Why it's interesting:
    - Identifies critical infrastructure layers
    - Measures redundancy in multilayer systems
    - Informs resilience strategies and backup planning
    - Essential for analyzing cascading failures
    
    DSL concepts demonstrated:
    - Layer selection and filtering
    - Computing connectivity metrics
    - Comparing network states (with/without layers)
    - Using functools.reduce for cleaner layer expressions
    
    Args:
        network: A multi_layer_network instance
        
    Returns:
        pd.DataFrame comparing connectivity with each layer removed
    """
    from functools import reduce
    import operator
    
    layers = _get_layer_names(network)
    
    # Baseline: connectivity with all layers
    baseline_result = (
        Q.nodes()
         .from_layers(L["*"])
         .compute("degree")
         .execute(network)
    )
    
    baseline_df = baseline_result.to_pandas()
    baseline_nodes = len(baseline_df)
    baseline_avg_degree = baseline_df['degree'].mean()
    baseline_total_degree = baseline_df['degree'].sum()
    
    results = [{
        'scenario': 'baseline (all layers)',
        'n_nodes': baseline_nodes,
        'avg_degree': round(baseline_avg_degree, 2),
        'total_edges': baseline_total_degree // 2,
        'connectivity_loss': 0.0
    }]
    
    # Test removing each layer (scenario loop - part of experiment design)
    for layer_to_remove in layers:
        # Build a layer expression that includes all layers except layer_to_remove
        remaining_exprs = [L[layer] for layer in layers if layer != layer_to_remove]
        
        if not remaining_exprs:
            continue
        
        # Combine remaining layers using reduce
        remaining_expr = reduce(operator.add, remaining_exprs)
        
        # Query with reduced layer set
        reduced_result = (
            Q.nodes()
             .from_layers(remaining_expr)
             .compute("degree")
             .execute(network)
        )
        
        if len(reduced_result) > 0:
            reduced_df = reduced_result.to_pandas()
            n_nodes = len(reduced_df)
            avg_degree = reduced_df['degree'].mean()
            total_degree = reduced_df['degree'].sum()
            
            # Calculate connectivity loss
            connectivity_loss = (baseline_total_degree - total_degree) / baseline_total_degree * 100
            
            results.append({
                'scenario': f'without {layer_to_remove}',
                'n_nodes': n_nodes,
                'avg_degree': round(avg_degree, 2),
                'total_edges': total_degree // 2,
                'connectivity_loss': round(connectivity_loss, 2)
            })
        else:
            results.append({
                'scenario': f'without {layer_to_remove}',
                'n_nodes': 0,
                'avg_degree': 0.0,
                'total_edges': 0,
                'connectivity_loss': 100.0
            })
    
    return pd.DataFrame(results)

Why It’s Interesting

  • Critical infrastructure identification — Reveals which layers are essential

  • Redundancy assessment — High robustness indicates good backup coverage

  • Failure planning — Informs which layers need extra protection

Example Output

Robustness of transport_network:

Robustness Analysis

Scenario

Nodes

Avg Degree

Total Edges

Connectivity Loss (%)

baseline (all layers)

14

2.14

15

0.0

without bus

11

1.45

8

46.67

without metro

11

1.82

10

33.33

without walking

14

2.0

14

6.67

Interpretation: Removing the bus layer causes 46.67% connectivity loss — it’s the most critical layer. Walking is least critical (only 6.67% loss), indicating good redundancy from other transport modes.

DSL Concepts Demonstrated

  • Layer algebra: L["layer1"] + L["layer2"] — Combine layers

  • Q.nodes().from_layers(layer_expr) — Query with dynamic layer selections

  • Baseline vs scenario comparison

  • Measuring connectivity metrics before/after perturbations


7. Advanced Centrality Comparison

Problem: Different centralities capture different notions of importance. Which nodes are “versatile hubs” (high in many centralities) vs “specialized hubs” (high in only one)?

Solution: Compute multiple centralities, normalize them, and classify nodes by how many centralities place them in the top tier.

Query Code

def query_advanced_centrality_comparison(network: Network) -> pd.DataFrame:
    """Compare multiple centrality measures on the aggregated multilayer network.
    
    Refactored: multilayer-aware with L["*"], no loops.
    
    This query computes several centrality measures (degree, betweenness, closeness,
    PageRank) and identifies nodes that rank high in multiple measures ("versatile hubs")
    versus those that excel in only one measure ("specialized hubs").
    
    Why it's interesting:
    - Different centralities capture different notions of importance
    - Versatile hubs are robust across different centrality definitions
    - Specialized hubs reveal specific structural roles
    - Essential for comprehensive node importance analysis
    
    DSL concepts demonstrated:
    - Computing multiple centrality measures in one query
    - Aggregating across all layers
    - Ranking and comparing across metrics
    - Using computed attributes for classification
    
    Args:
        network: A multi_layer_network instance
        
    Returns:
        pd.DataFrame with nodes and their centrality scores, plus a "versatility" metric
    """
    result = (
        Q.nodes()
         .from_layers(L["*"])  # aggregate across layers
         .compute("degree", "betweenness_centrality",
                  "closeness_centrality", "pagerank")
         .execute(network)
    )
    
    if len(result) == 0:
        return pd.DataFrame()
    
    df = result.to_pandas().rename(columns={'id': 'node'})
    
    # Normalize each centrality to [0, 1] for comparison
    for col in ['degree', 'betweenness_centrality', 'closeness_centrality', 'pagerank']:
        if col in df.columns:
            max_val = df[col].max()
            if max_val > 0:
                df[f'{col}_norm'] = df[col] / max_val
            else:
                df[f'{col}_norm'] = 0
    
    # Compute "versatility" - how many centralities place node in top 30%
    norm_cols = [c for c in df.columns if c.endswith('_norm')]
    
    def count_top_ranks(row):
        count = 0
        for col in norm_cols:
            if row[col] >= 0.7:  # Top 30% threshold
                count += 1
        return count
    
    df['versatility'] = df.apply(count_top_ranks, axis=1)
    
    # Classify nodes
    def classify_hub(row):
        if row['versatility'] >= 3:
            return 'versatile_hub'
        elif row['versatility'] >= 1:
            return 'specialized_hub'
        else:
            return 'peripheral'
    
    df['hub_type'] = df.apply(classify_hub, axis=1)
    
    # Sort by versatility and then by average normalized centrality
    df['avg_centrality'] = df[norm_cols].mean(axis=1)
    df = df.sort_values(['versatility', 'avg_centrality'], ascending=[False, False])
    
    # Select columns for output
    output_cols = ['node', 'degree', 'betweenness_centrality', 'closeness_centrality', 
                   'pagerank', 'versatility', 'hub_type']
    
    return df[output_cols].round(4)

Why It’s Interesting

  • Centrality is multifaceted — Degree ≠ betweenness ≠ closeness ≠ PageRank

  • Versatile hubs are robust — High across many metrics means genuine importance

  • Specialized hubs reveal roles — High in one metric reveals specific structural position

Example Output

Running on communication_network (email layer):

Node

Degree

Betweenness

Closeness

PageRank

Versatility

Type

Manager

9

1.0

1.0

0.4676

4

versatile_hub

Dev1

1

0.0

0.5294

0.0592

0

peripheral

Dev2

1

0.0

0.5294

0.0592

0

peripheral

Interpretation: Manager is a versatile hub (top 30% in all 4 centralities). All other nodes are peripheral in this star-topology email network.

DSL Concepts Demonstrated

  • .compute("degree", "betweenness_centrality", "closeness_centrality", "pagerank") — Compute multiple centralities

  • Normalizing centralities for comparison

  • Derived metrics (versatility score)

  • Classification based on computed attributes


8. Edge Grouping and Coverage

Problem: You want to analyze which edges (connections) are important within and between layers. Which edges consistently appear in the top-k across different layer-pair contexts?

Solution: Use the new .per_layer_pair() method to group edges by (src_layer, dst_layer) pairs, then apply top-k and coverage filtering.

Query Code

def query_edge_grouping_and_coverage(network: Network, k: int = 3) -> Dict[str, pd.DataFrame]:
    """Analyze edges across layer pairs with grouping and coverage.
    
    This query demonstrates the powerful new edge grouping capabilities
    introduced in DSL v2. It groups edges by (src_layer, dst_layer) pairs
    and analyzes edge distribution across layer pairs.
    
    Why it's interesting:
    - Reveals how connections are distributed within and between layers
    - Shows which layer pairs have more connectivity
    - Identifies edges that appear across multiple layer contexts
    - Essential for understanding cross-layer edge patterns
    
    DSL concepts demonstrated:
    - .per_layer_pair() for edge grouping
    - .coverage() for cross-group filtering
    - Edge-specific grouping metadata
    - .group_summary() for aggregate statistics
    
    Args:
        network: A multi_layer_network instance
        k: Number of edges to limit per layer pair (default: 3)
        
    Returns:
        Dictionary with:
        - 'edges_by_pair': DataFrame with edges grouped by layer pair
        - 'summary': DataFrame with edge counts per layer pair
    """
    # Query: Get edges grouped by layer pair
    result = (
        Q.edges()
         .from_layers(L["*"])
         .per_layer_pair()
            .top_k(k)  # Limit to k edges per pair
         .end_grouping()
         .execute(network)
    )
    
    if len(result) == 0:
        return {
            'edges_by_pair': pd.DataFrame(),
            'summary': pd.DataFrame()
        }
    
    # Get edges DataFrame
    df_edges = result.to_pandas()
    
    # Get group summary
    summary = result.group_summary()
    
    return {
        'edges_by_pair': df_edges,
        'summary': summary
    }

Why It’s Interesting

  • Layer-pair-aware analysis — Different layer pairs may have very different edge patterns

  • Universal edges — Edges important across multiple contexts are more robust

  • Cross-layer dynamics — Reveals how connections vary between intra-layer and inter-layer contexts

  • Edge-centric view — Complements node-centric analyses like hub detection

Example Output

Running on social_work_network with k=3:

Edges Grouped by Layer Pair (top 3 per pair):

Source

Target

Source Layer

Target Layer

Alice

Bob

social

social

Alice

Carol

social

social

Bob

Carol

social

social

Alice

Bob

work

work

Alice

Carol

work

work

Bob

Carol

work

work

Group Summary:

Source Layer

Target Layer

# Edges

social

social

3

work

work

3

family

family

3

social

work

1

Interpretation: The query reveals edge distribution across layer pairs. Each pair (e.g., social-social, work-work) contains up to k=3 edges. Inter-layer pairs (social-work) typically have fewer connections, showing the separation between layers. The family layer has sparser connectivity overall.

DSL Concepts Demonstrated

  • .per_layer_pair() — Group edges by (src_layer, dst_layer) pairs

  • .top_k(k, "weight") — Select top-k items per group

  • .coverage(mode="at_least", k=2) — Cross-group filtering

  • .group_summary() — Get aggregate statistics per group

  • Edge-specific grouping metadata in QueryResult.meta["grouping"]

Tip

New in DSL v2

Edge grouping and coverage are new features that parallel the existing node grouping capabilities. Use .per_layer_pair() for edges and .per_layer() for nodes. Both support the same coverage modes and grouping operations.


Using the Query Zoo

Getting Started

  1. Install py3plex (if not already installed):

    pip install py3plex
    
  2. Run a single query:

    from examples.dsl_query_zoo.datasets import create_social_work_network
    from examples.dsl_query_zoo.queries import query_basic_exploration
    
    net = create_social_work_network(seed=42)
    result = query_basic_exploration(net)
    print(result)
    
  3. Run all queries:

    cd examples/dsl_query_zoo
    python run_all.py
    
  4. Run tests:

    pytest tests/test_dsl_query_zoo.py -v
    

Adapting Queries to Your Data

All queries are designed to work with any multi_layer_network object. To adapt:

  1. Replace the dataset:

    from py3plex.core import multinet
    
    # Load your own network
    my_network = multinet.multi_layer_network()
    my_network.load_network("mydata.edgelist", input_type="edgelist_mx")
    
    # Run any query
    result = query_cross_layer_hubs(my_network, k=10)
    
  2. Adjust parameters:

    • k in query_cross_layer_hubs — Number of top nodes per layer

    • Layer names in filters — Replace L["social"] with your layer names

    • Centrality thresholds — Adjust percentile cutoffs as needed

  3. Extend queries:

    All query functions are in examples/dsl_query_zoo/queries.py. Copy, modify, and experiment!

Datasets

Three multilayer networks are provided:

  1. social_work_network

    • Layers: social, work, family

    • Nodes: 12 people

    • Structure: Overlapping social circles with different connectivity patterns per layer

  2. communication_network

    • Layers: email, chat, phone

    • Nodes: 10 people (Manager, Dev team, Marketing, Support, HR)

    • Structure: Star topology in email, distributed in chat/phone

  3. transport_network

    • Layers: bus, metro, walking

    • Nodes: 8 locations (CentralStation, ShoppingMall, Park, etc.)

    • Structure: Bus covers most locations, metro is faster but selective, walking is local

All datasets use fixed random seeds (seed=42) for reproducibility.

Further Reading

  • How to Query Multilayer Graphs with the SQL-like DSL — Complete DSL reference with syntax and operators

  • Multilayer Networks 101 — Theory of multilayer networks

  • DSL Reference — Full DSL grammar and API reference

  • ../tutorials/tutorial_10min — Quick start tutorial

Contributing Queries

Have an interesting multilayer query pattern? Contribute it to the Query Zoo!

  1. Add your query function to examples/dsl_query_zoo/queries.py

  2. Add tests to tests/test_dsl_query_zoo.py

  3. Update this documentation page

  4. Submit a pull request!

See Contributing to py3plex for details.

Previous Next

© Copyright 2020-2025, Blaž Škrlj.

Built with Sphinx using a theme provided by Read the Docs.