Skip to main content

A Multilayer network analysis python3 library

Project description

py3plex logo

Tests Examples Tutorial Code Quality Benchmarks Documentation Formal Verification Fuzzing PyPI version CLI Tool Docker Lines of Code Test Count

Multilayer networks are complex networks with additional information assigned to nodes or edges (or both). This library includes some of the state-of-the-art algorithms for decomposition, visualization and analysis of such networks.

Key Features:

  • SQL-like DSL for intuitive network queries with smart defaults
  • Multilayer network visualization and analysis
  • Community detection and centrality measures
  • Network decomposition and embeddings
from py3plex.core import datasets
from py3plex.dsl import Q, UQ
from py3plex.algorithms.community_detection import multilayer_louvain

# 1. Load a built-in multilayer biological network (~500 nodes, 4 layers)
network = datasets.fetch_multilayer("human_ppi_gene_disease_drug")

# 2. Run multilayer community detection
partition_vector, Q_modularity = multilayer_louvain(network, gamma=1.2, random_state=42)
network.assign_partition(partition_vector)

# 3. Find master regulator candidates with uncertainty quantification
master_regulators = (
    Q.nodes()
     .node_type("gene")                        # Filter by node type
     .where(degree__gt=3)                      # Remove peripheral genes
     .uq(method="perturbation", n_samples=100, ci=0.95, seed=42)  # Quantify confidence
     .per_layer()                              # Group by layer
        .compute("degree_centrality", "betweenness_centrality")
        .top_k(20, "betweenness_centrality__mean")  # Top 20 per layer by mean
     .end_grouping()
     .coverage(mode="at_least", k=2)           # Keep genes that are hubs in ≥2 layers
     .mutate(                                  # Create derived influence score
         influence_score=lambda row: (
             row.get("degree_centrality__mean", 0) * 0.4 +
             row.get("betweenness_centrality__mean", 0) * 0.6
         )
     )
     .sort(by="influence_score", descending=True)
     .limit(20)                                # Final top 20 candidates
     .explain(neighbors_top=5)                 # Enrich each gene with: community ID, top 5 interaction partners, layer presence
     .execute(network)
)

df = master_regulators.to_pandas(expand_uncertainty=True, expand_explanations=True)
print(df[["id", "layer", "betweenness_centrality", "betweenness_centrality_std", 
          "betweenness_centrality_ci95_low", "betweenness_centrality_ci95_high",
          "influence_score", "community_id", "top_neighbors"]].head(10))

Emits:

Found 287 communities, modularity = 0.649
    id  layer  betweenness_centrality  betweenness_centrality_std  betweenness_centrality_ci95_low  betweenness_centrality_ci95_high  influence_score  community_id                                      top_neighbors
0  252      0                0.025961                    0.002134                         0.021820                          0.030102         0.015577            42  [{'id': '91', 'weight': 2.3}, {'id': '419',...
1   91      0                0.024918                    0.002051                         0.020902                          0.028934         0.014951            42  [{'id': '252', 'weight': 2.3}, {'id': '103...
2  419      0                0.024184                    0.001987                         0.020298                          0.028070         0.014510            42  [{'id': '252', 'weight': 1.9}, {'id': '91'...
...

Note: The .coverage(mode="at_least", k=2) operator filters nodes to keep only those that appear in the top-20 of at least 2 layers, ensuring we find robust master regulators that are consistently important across the multilayer structure. The .explain() method enriches each individual gene result with interpretability features: (1) which community the gene belongs to, (2) the top 5 genes it interacts with most strongly (by edge weight), and (3) which layers the gene appears in.

Py3plex Visualization Showcase

Getting Started

Installation

We recommend using uv for fast, reliable Python environment management:

# Install uv (if not already installed)
curl -LsSf https://astral.sh/uv/install.sh | sh

# Create and activate virtual environment
uv venv .venv
source .venv/bin/activate  # On Windows: .venv\Scripts\activate

# Install py3plex
uv pip install py3plex

# Or install from source with development dependencies
uv pip install -e ".[dev]"

Alternatively, use pip:

pip install py3plex

Optional Features

Install additional features as needed:

# MCP server for AI agent integration (requires Python 3.10+)
pip install py3plex[mcp]

# Community detection algorithms
pip install py3plex[algos]

# Advanced visualization
pip install py3plex[viz]

# All optional features
pip install py3plex[mcp,algos,viz]

MCP Integration (AI Agents)

py3plex provides a Model Context Protocol (MCP) server for integration with AI coding assistants:

Requirements: Python 3.10 or higher (due to MCP SDK dependency)

# Install with MCP support (Python 3.10+ required)
pip install py3plex[mcp]

# Start MCP server
py3plex-mcp

Configure Claude Desktop (claude_desktop_config.json):

{
  "mcpServers": {
    "py3plex": {
      "command": "py3plex-mcp"
    }
  }
}

The MCP server exposes:

  • 7 tools: Load networks, run queries, detect communities, export results, and more
  • 3 resources: Complete documentation, DSL reference, and tool schemas
  • Security-first: Safe file access, automatic output directory, structured errors

See AGENTS.md for complete MCP documentation.

Resources

License

Py3plex is released under the MIT License.

Note on licensing: Prior to version 1.0, the project was distributed under the BSD-3-Clause license. Starting with version 1.0, the license was changed to MIT to better align with the broader Python scientific ecosystem and simplify contribution and reuse. Both licenses are permissive and OSI-approved.

Citations

@Article{Skrlj2019,
author={Skrlj, Blaz
and Kralj, Jan
and Lavrac, Nada},
title={Py3plex toolkit for visualization and analysis of multilayer networks},
journal={Applied Network Science},
year={2019},
volume={4},
number={1},
pages={94},
abstract={Complex networks are used as means for representing multimodal, real-life systems. With increasing amounts of data that lead to large multilayer networks consisting of different node and edge types, that can also be subject to temporal change, there is an increasing need for versatile visualization and analysis software. This work presents a lightweight Python library, Py3plex, which focuses on the visualization and analysis of multilayer networks. The library implements a set of simple graphical primitives supporting intra- as well as inter-layer visualization. It also supports many common operations on multilayer networks, such as aggregation, slicing, indexing, traversal, and more. The paper also focuses on how node embeddings can be used to speed up contemporary (multilayer) layout computation. The library's functionality is showcased on both real and synthetic networks.},
issn={2364-8228},
doi={10.1007/s41109-019-0203-7},
url={https://doi.org/10.1007/s41109-019-0203-7}
}

and

@InProceedings{10.1007/978-3-030-05411-3_60,
author="{\v{S}}krlj, Bla{\v{z}}
and Kralj, Jan
and Lavra{\v{c}}, Nada",
editor="Aiello, Luca Maria
and Cherifi, Chantal
and Cherifi, Hocine
and Lambiotte, Renaud
and Li{\'o}, Pietro
and Rocha, Luis M.",
title="Py3plex: A Library for Scalable Multilayer Network Analysis and Visualization",
booktitle="Complex Networks and Their Applications VII",
year="2019",
publisher="Springer International Publishing",
address="Cham",
pages="757--768",
abstract="Real-life systems are commonly represented as networks of interacting entities. While homogeneous networks consist of nodes of a single node type, multilayer networks are characterized by multiple types of nodes or edges, all present in the same system. Analysis and visualization of such networks represent a challenge for real-life complex network applications. The presented Py3plex Python-based library facilitates the exploration and visualization of multilayer networks. The library includes a diagonal projection-based network visualization, developed specifically for large networks with multiple node (and edge) types. The library also includes state-of-the-art methods for network decomposition and statistical analysis. The Py3plex functionality is showcased on real-world multilayer networks from the domains of biology and on synthetic networks.",
isbn="978-3-030-05411-3"
}

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

py3plex-1.1.1.tar.gz (1.5 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

py3plex-1.1.1-py3-none-any.whl (1.1 MB view details)

Uploaded Python 3

File details

Details for the file py3plex-1.1.1.tar.gz.

File metadata

  • Download URL: py3plex-1.1.1.tar.gz
  • Upload date:
  • Size: 1.5 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for py3plex-1.1.1.tar.gz
Algorithm Hash digest
SHA256 8cdc07d479490bfb688621801b3d6d31741b241b07101c7cc29fbd89c107dd14
MD5 c4a1072dd6c46959709fd4f3c61c6abe
BLAKE2b-256 bf61abe73c0292e91bf8c85fdca3e6cfbf7d393b56f1449c17f30f5a1fadcee2

See more details on using hashes here.

File details

Details for the file py3plex-1.1.1-py3-none-any.whl.

File metadata

  • Download URL: py3plex-1.1.1-py3-none-any.whl
  • Upload date:
  • Size: 1.1 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for py3plex-1.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 ecab234f1195b7417f92cb2a5dcd91851fa8456d36b411318f9b83918a755723
MD5 d41f06f7e1a50c94b8b37e0a597210a1
BLAKE2b-256 bd0e4021efe5f0f90c21698322c6d1f6efdc86fb5048428b310a74aaff131f23

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page