Skip to main content

Generalised Configuration Model random Graphs in Python

Project description

https://badge.fury.io/py/gcmpy.svg https://readthedocs.org/projects/peterstandrews-gcmpy/badge/?version=latest https://github.com/PeterStAndrews/gcmpy/actions/workflows/ci.yml/badge.svg

Overview

gcmpy is a Python library that creates random graph models according to the generalised configuration model (GCM). Random graph models provide an excellent framework to integrate topology with dynamics. The topology of a network is crucial to the outcome of a dynamical process, such as an epidemic, occurring over a network.

To create the networks, gcmpy creates a joint degree distribution object through a variety of analytical or empirical methods. Once constructed, this joint distribution is sampled to obtain a joint degree sequence. The joint sequence is then used in the GCM algorithm to create an edge list.

Networks can be given storage tags to classify the properties for database look-up.

Installation

You can install gcmpy directly from PyPi using pip:

pip install gcmpy

The master distribution of gcmpy is hosted on GitHub. To obtain a copy, just clone the repo:

git clone git@github.com:PeterStAndrews/gcmpy.git
cd gcmpy
python setup.py install

Documentation

API documentation for gcmpy is available on ReadTheDocs

Author and license

Copyright (c) 2021, Peter Mann <pm78@st-andrews.ac.uk>

Licensed under the GNU General Public License v2 or later (GPLv2+).

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

gcmpy-0.0.4.tar.gz (299.3 kB view hashes)

Uploaded Source

Supported by

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