Metadata-Version: 2.1
Name: gcmpy
Version: 0.0.3
Summary: Generalised Configuration Model random Graphs in Python
Home-page: https://github.com/PeterStAndrews/gcmpy
Author: Peter Mann
Author-email: pm78@st-andrews.ac.uk
License: License :: OSI Approved :: GNU General Public License v2 or later (GPLv2+)
Platform: UNKNOWN
Classifier: Intended Audience :: Science/Research
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Topic :: Scientific/Engineering
Requires-Python: >=3.8
License-File: LICENSE

gcmpy: Generalised Configuration Model random graphs in Python
===================================================================

.. image:: https://badge.fury.io/py/gcmpy.svg
    :target: https://badge.fury.io/py/gcmpy

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

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``:

.. code-block:: bash

   pip install gcmpy

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

.. code-block:: bash
    
    git clone git@github.com:PeterStAndrews/gcmpy.git
    cd gcmpy
    python setup.py install



Documentation
-------------

API documentation for ``gcmpy`` is available on `ReadTheDocs <https://peterstandrews-gcmpy.readthedocs.io/en/latest/>`_


Author and license
------------------

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

Licensed under the `GNU General Public License v2 or later (GPLv2+) <http://www.gnu.org/licenses/gpl.html>`_.

