:class:`CorePeripheryNetwork`: A core-periphery network generator
=================================================================

.. currentmodule:: epydemic

.. autoclass:: CorePeripheryNetwork

Experimental parameters
-----------------------

.. autoattribute:: CorePeripheryNetwork.N_core

.. autoattribute:: CorePeripheryNetwork.PHI_core

.. autoattribute:: CorePeripheryNetwork.N_per

.. autoattribute:: CorePeripheryNetwork.PHI_per

The generated network also has a node attribute defined:

.. autoattribute:: CorePeripheryNetwork.ORIGIN


Generator methods
-----------------

.. automethod:: CorePeripheryNetwork.topology

.. automethod:: CorePeripheryNetwork._generate


Accessing the core and periphery
--------------------------------

For networks generated by this generator, we can extract the
sub-networks comprising the core and periphery. Only the edges within
the sub-network will be included.

.. automethod:: CorePeripheryNetwork.coreSubNetwork

.. automethod:: CorePeripheryNetwork.peripherySubNetwork