.. card_deck documentation master file, created by
   sphinx-quickstart on Sun Jun 20 19:49:24 2021.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to card_deck's documentation!
=====================================

We propose a validated computational model of the spread of an antibiotic
resistant pathogens in a hospital, with and without our diagnostic tool for
quickly identifying it, and show that in a relevant scenario it reduces the
presence of antibiotic resistant pathogens in our selected scenario, showing our
product is beneficial in the real-world.

We used Python to implement a discrete time, stochastic, compartmental model of
the spread of antibiotic resistant pathogens through a population.

Installation
------------

The library package has been published on PyPi, so can be found here:
https://pypi.org/project/tiered-antibiotic-resistance-model/, and can be
installed as follows:

.. code-block:: python

    pip install tiered-antibiotic-resistance-model

Requirements
------------

There are no additional required libraries


Contents
--------

.. toctree::
   :maxdepth: 2

   project
   writeup
   usage
   autodoc


Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`