.. _reference:

.. currentmodule:: epydemic

API reference
=============


Basic concepts and classes
--------------------------

.. toctree::
   :maxdepth: 2

   helper-types
   generator
   process
   loci
   networkexperiment
   networkdynamics
   compartmentedmodel


Dynamics: How processes are simulated
-------------------------------------

.. toctree::
   :maxdepth: 2

   synchronousdynamics
   stochasticdynamics


Reference epidemic disease processes
------------------------------------

.. toctree::
   :maxdepth: 2

   sir
   sis
   seir


Disease process variants
------------------------

.. toctree::
   :maxdepth: 2

   sir_fixed_recovery
   sir_variable_infection
   sis_fixed_recovery
   sirs


Other processes
---------------

.. toctree::
   :maxdepth: 2

   adddelete
   pulsecoupled
   percolate
   shuffle
   opinion
   sivr
   vaccinate


Analysis processes
------------------

.. toctree::
   :maxdepth: 2

   monitor
   statistics


Process combinators
--------------------

.. toctree::
   :maxdepth: 2

   processsequence


Other experiments
-----------------

.. toctree::
   :maxdepth: 2

   newmanziff


Network generators
------------------

.. toctree::
   :maxdepth: 2

   standard_generators
   core-periphery_generator
   modular_generator


Generating functions
--------------------

.. toctree::
   :maxdepth: 2

   gf
   standard-gfs

Supporting code
---------------

.. toctree::
   :maxdepth: 2

   rng
   drawset