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.

A 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: Last but not least, 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:

  • 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 us

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={},
  number={},
  pages={1-13},
  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.16.0rc20240725134839

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.16.0rc20240725134839
File Size Uploaded Provenance Actions
network_diffusion-0.16.0rc20240725134839.tar.gz 60.0 kB Without provenance Details for network_diffusion-0.16.0rc20240725134839.tar.gz

Built distributions (wheels)

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

Total release size: 348.5 kB

Release files / network_diffusion-0.16.0rc20240725134839.tar.gz

Download URL network_diffusion-0.16.0rc20240725134839.tar.gz
Size 60.0 kB
Tags Source
SHA-256 checksum
How to use checksums
01e907f9c73bbaa87763242e91e498499b652d3e745e540ac2a7229990abe9d6
BLAKE2b-256 checksum
How to use checksums
d21fd5501d94a573c3efde5145ec1f0241e575e49dee4cf1f962ab459fc4a7a4
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/5.1.0 CPython/3.12.4

Release files / network_diffusion-0.16.0rc20240725134839-cp312-cp312-win_amd64.whl

Download URL network_diffusion-0.16.0rc20240725134839-cp312-cp312-win_amd64.whl
Size 89.8 kB
Tags CPython 3.12 Windows x86-64
SHA-256 checksum
How to use checksums
12d2e20028d10a5c1746b48fd77d36375b45280dde01994ad0c1d988a5eff3e8
BLAKE2b-256 checksum
How to use checksums
aa3eeba88cd771c70ad8d5db32260fa3bedd3b7bc9232b55743919d9ac14dba3
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/5.1.0 CPython/3.12.4

Release files / network_diffusion-0.16.0rc20240725134839-cp312-cp312-manylinux_2_5_x86_64.manylinux1_x86_64.whl

Download URL network_diffusion-0.16.0rc20240725134839-cp312-cp312-manylinux_2_5_x86_64.manylinux1_x86_64.whl
Size 105.6 kB
Tags CPython 3.12 Linux glibc 2.5+ x86-64
SHA-256 checksum
How to use checksums
da0d596f87c4b69e14c3465f854e0255a9c8509e884bf7775b4f45a759df3850
BLAKE2b-256 checksum
How to use checksums
a3757fac2dcf0f902f6122c46150cf789af764cd6336d9f4cb2f38dc5b911d0f
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/5.1.0 CPython/3.12.4

Release files / network_diffusion-0.16.0rc20240725134839-cp312-cp312-macosx_10_9_universal2.whl

Download URL network_diffusion-0.16.0rc20240725134839-cp312-cp312-macosx_10_9_universal2.whl
Size 93.0 kB
Tags CPython 3.12 macOS 10.9+ universal2 (ARM64, x86-64)
SHA-256 checksum
How to use checksums
9fe813ba1292e4a3bb1cab489faf80ee713565adf891774d3c510ac9fdb4f62e
BLAKE2b-256 checksum
How to use checksums
d0798c0d9f119ad75f12dd4b1a0f9c70cf4c8e7fe1cabc0627081b4eb43c5bfd
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/5.1.0 CPython/3.12.4

Security for network-diffusion 0.16.0rc20240725134839

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