**************
Setup Matrices
**************

This page contains information about the different classes used for setting up regional and contact matrices for the models included in epimodels.

.. currentmodule:: epimodels

Overview:

- :class:`ContactMatrix`
- :class:`RegionMatrix`
- :class:`UniNextGenMatrix`
- :class:`MultiTimesContacts`
- :class:`UniInfectivityMatrix`
- :class:`MultiTimesInfectivity`

Contact Population Matrix
*************************

.. autoclass:: ContactMatrix
  :members:

Region-specific Susceptibility Matrix
*************************************

.. autoclass:: RegionMatrix
  :members:

Mono Time&Region-specific New Infections Matrix
***********************************************

.. autoclass:: UniNextGenMatrix
  :members:

Multi Time&Region-specific Contact Matrix
*****************************************

.. autoclass:: MultiTimesContacts
  :members:

Mono Time&Region-specific Infectivity Matrix and Reproduction Number Computer
*****************************************************************************

.. autoclass:: UniInfectivityMatrix
  :members:

Multi Time&Region-specific Infectivity Matrix and Reproduction Number Computer
******************************************************************************

.. autoclass:: MultiTimesInfectivity
  :members: