Skip to main content
Pre-release

This release is a pre-release and may not be stable for production use.

Network Diffusion - Spreading Models in Networks

Licence PyPI version

Tests Builds Docs Codecov FOSSA Status

This Python library provides a versatile toolkit for simulating diffusion processes in complex networks. It offers support for various types of models, including temporal models, multilayer models, and combinations of both.

Short Example

import network_diffusion as nd

# define the model with its internal parameters
spreading_model = nd.models.MICModel(
    seeding_budget=[90, 10, 0],  # 95% act suspected, 10% infected, 0% recovered
    seed_selector=nd.seeding.RandomSeedSelector(),  # pick infected act randomly
    protocol="OR",  # how to aggregate impulses from the network's layers
    probability=0.5,  # probability of infection
)

# get the graph - a medium for spreading
network = nd.mln.functions.get_toy_network_piotr()

# perform the simulation that lasts four epochs
simulator = nd.Simulator(model=spreading_model, network=network)
logs = simulator.perform_propagation(n_epochs=3)

# obtain detailed logs for each actor in the form of JSON
raw_logs_json = logs.get_detailed_logs()

# or obtain aggregated logs for each of the network's layer
aggregated_logs_json = logs.get_aggragated_logs()

# or just save a summary of the experiment with all the experiment's details
logs.report(visualisation=True, path="my_experiment")

Key Features

  • Complex Network Simulation: The library enables users to simulate diffusion processes in complex networks with ease. Whether you are studying information spread, disease propagation, or any other diffusion phenomena, this library has you covered.

  • Temporal Models: You can work with temporal models, allowing you to capture the dynamics of processes over time. These temporal models can be created using regular time windows or leverage CogSnet.

  • Multilayer Networks: The library supports multilayer networks, which are essential for modelling real-world systems with interconnected layers of complexity.

  • Predefined Models: You have the option to use predefined diffusion models such as the Linear Threshold Model, Independent Cascade Model, and more. These models simplify the simulation process, allowing you to focus on your specific research questions.

  • Custom Models: Additionally, Network Diffusion allows you to define your own diffusion models using open interfaces, providing flexibility for researchers to tailor simulations to their unique requirements.

  • Centrality Measures: The library provides a wide range of centrality measures specifically designed for multilayer networks. These measures can be valuable for selecting influential seed nodes in diffusion processes.

  • NetworkX Compatible: The package is built on top of NetworkX, ensuring seamless compatibility with this popular Python library for network analysis. You can easily integrate it into your existing NetworkX-based workflows.

  • PyTorch representation: Network Diffusion offers a plausible converter of the multilayer network to PyTorch sparse representation. That feature can help in deep-learning experiments utilising complex networks (e.g. GNNs).

Package Installation

To install the package, run this command: pip install network_diffusion. Please note that we currently support Linux, MacOS, and Windows, but the package is mostly tested and developed on Unix-based systems.

To contribute, please clone the repo, switch to a new feature branch, and install the environment:

conda env create -f env/conda.yml
conda activate network-diffusion
pip install -e .

Documentation

Reference guide is available here!

Please bear in mind that this project is still in development, so the API usually differs between versions. Nonetheless, the code is documented well, so we encourage users to explore the repository. Another way to familiarise yourself with the operating principles of network_diffusion are projects which utilise it:

  • Assessment of using control methods for influence maximisation - v0.17.0 - repo
  • Generator of a dataset with actors' spreading potentials - v0.16.0 - repo
  • Influence max. under LTM in multilayer networks - v0.14.0 pre-release - repo
  • Comparison of spreading in various temporal network models - v0.13.0 - repo
  • Seed selection methods for ICM in multilayer networks - v0.10.0 - repo
  • Modelling coexisting spreading phenomena - v0.6 - repo

Citing the Library

If you used the package, please consider citing us:

@article{czuba2024networkdiffusion,
  title={Network Diffusion Framework to Simulate Spreading Processes in Complex Networks},
  author={
      Czuba, Micha{\l} and Nurek, Mateusz and Serwata, Damian and Qi, Yu-Xuan
      and Jia, Mingshan and Musial, Katarzyna and Michalski, Rados{\l}aw
      and Br{\'o}dka, Piotr
    },
  journal={Big Data Mining And Analytics},
  volume={7},
  number={3},
  pages={637-654},
  year={2024},
  publisher={IEEE},
  doi = {10.26599/BDMA.2024.9020010},
  url={https://doi.org/10.26599/BDMA.2024.9020010},
}

Particularly if you used the functionality of simulating coexisting phenomena in complex networks, please add the following reference:

@inproceedings{czuba2022coexisting,
  author={Czuba, Micha\l{} and Br\'{o}dka, Piotr},
  booktitle={9th International Conference on Data Science and Advanced Analytics (DSAA)},
  title={Simulating Spreading of Multiple Interacting Processes in Complex Networks},
  volume={},
  number={},
  pages={1-10},
  year={2022},
  month={oct},
  publisher={IEEE},
  address={Shenzhen, China},
  doi={10.1109/DSAA54385.2022.10032425},
  url={https://ieeexplore.ieee.org/abstract/document/10032425},
}

Reporting Bugs

Please report bugs on this board or by sending a direct e-mail to the main author.

About Us

This library is developed and maintained by Network Science Lab from Politechnika Wrocławska / Wrocław University of Science and Technology / Technische Universität Breslau and external partners. For more information and updates, please visit our website or GitHub page.

Metadata

Release files for network-diffusion 0.18.0rc20250526114731

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for network-diffusion 0.18.0rc20250526114731
File Size Uploaded Provenance Actions
network_diffusion-0.18.0rc20250526114731.tar.gz 102.5 kB Without provenance Details for network_diffusion-0.18.0rc20250526114731.tar.gz

Built distributions (wheels)

Table of built distributions (wheels) for network-diffusion 0.18.0rc20250526114731
File Interpreter ABI Platform Actions
network_diffusion-0.18.0rc20250526114731-cp312-cp312-win_amd64.whl CPython 3.12 CPython 3.12 Windows x86-64 Details for network_diffusion-0.18.0rc20250526114731-cp312-cp312-win_amd64.whl
network_diffusion-0.18.0rc20250526114731-cp312-cp312-manylinux1_x86_64.manylinux_2_5_x86_64.whl CPython 3.12 CPython 3.12 Linux glibc 2.5+ x86-64 Details for network_diffusion-0.18.0rc20250526114731-cp312-cp312-manylinux1_x86_64.manylinux_2_5_x86_64.whl
network_diffusion-0.18.0rc20250526114731-cp312-cp312-macosx_10_13_universal2.whl CPython 3.12 CPython 3.12 macOS 10.13+ universal2 (ARM64, x86-64) Details for network_diffusion-0.18.0rc20250526114731-cp312-cp312-macosx_10_13_universal2.whl

Total release size: 529.8 kB

Release files / network_diffusion-0.18.0rc20250526114731.tar.gz

Download URL network_diffusion-0.18.0rc20250526114731.tar.gz
Size 102.5 kB
Tags Source
SHA-256 checksum
How to use checksums
ea46101547101c45e0047789c4a22096b850830828a683806912a7b32fa28b3b
BLAKE2b-256 checksum
How to use checksums
81821dd595082c3f9687aaaf48625fde8ed8e26f3ca0994941b687de72813b93
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/5.1.1 CPython/3.12.10

Release files / network_diffusion-0.18.0rc20250526114731-cp312-cp312-win_amd64.whl

Download URL network_diffusion-0.18.0rc20250526114731-cp312-cp312-win_amd64.whl
Size 136.4 kB
Tags CPython 3.12 Windows x86-64
SHA-256 checksum
How to use checksums
2a12456127741a3b818a18c4e7b779b319a66defd97915cad27bf3643aefa970
BLAKE2b-256 checksum
How to use checksums
512bae66b68654254cdf9e76fec60e79d549d24503850720a8e815f184b1bdac
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/5.1.1 CPython/3.12.10

Release files / network_diffusion-0.18.0rc20250526114731-cp312-cp312-manylinux1_x86_64.manylinux_2_5_x86_64.whl

Download URL network_diffusion-0.18.0rc20250526114731-cp312-cp312-manylinux1_x86_64.manylinux_2_5_x86_64.whl
Size 151.8 kB
Tags CPython 3.12 Linux glibc 2.5+ x86-64
SHA-256 checksum
How to use checksums
4f4dda52b58edcfd21a16bad0fb4968a7ff0dc117fbf4cb2ca701f60870e7ad2
BLAKE2b-256 checksum
How to use checksums
a55aa78e3888a82b2258ad0c87026c57da8c09d1bb5d1067686123ab476a46a5
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/5.1.1 CPython/3.12.10

Release files / network_diffusion-0.18.0rc20250526114731-cp312-cp312-macosx_10_13_universal2.whl

Download URL network_diffusion-0.18.0rc20250526114731-cp312-cp312-macosx_10_13_universal2.whl
Size 139.1 kB
Tags CPython 3.12 macOS 10.13+ universal2 (ARM64, x86-64)
SHA-256 checksum
How to use checksums
ac46b1b303622f9913c2b9b2548d8c76a978390f23b7df401fcfcf56123274c4
BLAKE2b-256 checksum
How to use checksums
e2ddc6ba69c9700d89bf11f6c031351efac8a688afc803efc18854aa32807c6b
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/5.1.1 CPython/3.12.10

Security for network-diffusion 0.18.0rc20250526114731

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page