Skip to main content

Network Diffusion - a package for simulating spreading phenomena.

Project description

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 note that this project is still under development, and the API may vary between versions. Nevertheless, the code is thoroughly commented and the documentation is kept up to date. Another way to become familiar with the operating principles of network_diffusion is to explore some example projects that make use of it:

  • Assessment of using control methods for influence maximisation - v0.17 - repo
  • Generator of a dataset with actors' spreading potentials - v0.16 - repo
  • Influence max. under LTM in multilayer networks - v0.14 - repo
  • Modelling of concurrent spreading and a diffusion in temporal networks - v0.13 - repo
  • Seed selection methods for ICM in multilayer networks - v0.10 - 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},
}

About Us

This library is developed and maintained by Network Science Lab from Wroclaw University of Science and Technology. For more information and updates, please visit our website or GitHub page.

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

network_diffusion-0.18.1.tar.gz (105.9 kB view details)

Uploaded Source

Built Distributions

network_diffusion-0.18.1-cp312-cp312-win_amd64.whl (141.6 kB view details)

Uploaded CPython 3.12Windows x86-64

network_diffusion-0.18.1-cp312-cp312-manylinux1_x86_64.manylinux_2_5_x86_64.whl (157.1 kB view details)

Uploaded CPython 3.12manylinux: glibc 2.5+ x86-64

network_diffusion-0.18.1-cp312-cp312-macosx_10_13_universal2.whl (144.3 kB view details)

Uploaded CPython 3.12macOS 10.13+ universal2 (ARM64, x86-64)

File details

Details for the file network_diffusion-0.18.1.tar.gz.

File metadata

  • Download URL: network_diffusion-0.18.1.tar.gz
  • Upload date:
  • Size: 105.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.11

File hashes

Hashes for network_diffusion-0.18.1.tar.gz
Algorithm Hash digest
SHA256 a829a62df5f75291fa5a2a1106a99b14c3672f5278c7447dc15f04c75dafa03c
MD5 add567530d66637847000b448655b351
BLAKE2b-256 acf082043d2148e2fea7a371fc695856993c9cdec1bd94b7d641409565ab7440

See more details on using hashes here.

File details

Details for the file network_diffusion-0.18.1-cp312-cp312-win_amd64.whl.

File metadata

File hashes

Hashes for network_diffusion-0.18.1-cp312-cp312-win_amd64.whl
Algorithm Hash digest
SHA256 160470d9eeeb38048ee09caf722f2488c66d6c7bf9f2e4a9974e6c1dedb36627
MD5 5b1a7cda4a09503289cec372df2fba35
BLAKE2b-256 ea6679fe62419ba3631352dd103cca5d2255f74888f92b33d5d22056819bfaba

See more details on using hashes here.

File details

Details for the file network_diffusion-0.18.1-cp312-cp312-manylinux1_x86_64.manylinux_2_5_x86_64.whl.

File metadata

File hashes

Hashes for network_diffusion-0.18.1-cp312-cp312-manylinux1_x86_64.manylinux_2_5_x86_64.whl
Algorithm Hash digest
SHA256 697ba7a3e349caf6b45cc5ba6188adde89271bbe6af7e26777713bf6d2714ae2
MD5 d3aff812fd7f3a9d2f5ca074907c4cbd
BLAKE2b-256 3b328a10e62e494b44d4ffb398f70195cd48e1d0b11744593c70ce2dd01783d4

See more details on using hashes here.

File details

Details for the file network_diffusion-0.18.1-cp312-cp312-macosx_10_13_universal2.whl.

File metadata

File hashes

Hashes for network_diffusion-0.18.1-cp312-cp312-macosx_10_13_universal2.whl
Algorithm Hash digest
SHA256 8edd55a6a3de32a033f24d13d059c70a3f2d315d960fd3b62cf92ff95d13e3fc
MD5 5692c51cf46948e59051a46f194f82cb
BLAKE2b-256 9f978c0d60f85599bce9be5a0c2a8cba1e50fbc6d16a7f895f027b01bacff672

See more details on using hashes here.

Supported by

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