:class:`ModularNetwork`: A modular ER network generator
=======================================================

.. currentmodule:: epydemic

.. autoclass:: ModularNetwork

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

.. autoattribute:: ModularNetwork.N_core

.. autoattribute:: ModularNetwork.PHI_core

.. autoattribute:: ModularNetwork.SATELLITES

.. autoattribute:: ModularNetwork.N_sat

.. autoattribute:: ModularNetwork.PHI_sat

The network will also have two attributes defined on its nodes:

.. autoattribute:: ModularNetwork.ORIGIN

.. autoattribute:: ModularNetwork.CORE_LINK


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

.. automethod:: ModularNetwork.topology

.. automethod:: ModularNetwork._generate


Accessing the core and satellites
---------------------------------

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

.. automethod:: ModularNetwork.coreSubNetwork

.. automethod:: ModularNetwork.satelliteSubNetwork