.. TLO Model: Profiling documentation master file, created by
   sphinx-quickstart on Thu Aug 17 13:46:22 2023.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to the TLO Model: Profiling Documentation
=================================================

.. toctree::
   :maxdepth: 1
   :caption: Contents:

   index
   run-statistics
   developers
   api-reference

This is a repository for storing profiling outputs from the TLOmodel, an epidemiology modelling framework for the Thanzi la Onse project.

Running Simulations with the Model
----------------------------------

For more information about setting up, using, and running simulations using the model, `please see the main repository <https://github.com/UCL/TLOmodel>`_ and information provided there.

View the Profiling Results
--------------------------

Profiling results are hosted on `GitHub pages <http://github-pages.ucl.ac.uk/TLOmodel-profiling>`_ and are built using ``sphinx`` and some custom Python scripts to process the results data.

* :doc:`Lookup table for profiling runs <index>`
* :doc:`Summary page for captured run statistics <run-statistics>`

Developer Documentation
-----------------------

For developer information about this repository; such as how the repository is organised, how the website is built, and documentation for the functions and scripts, :doc:`please see the online documentation <developers>`.

API Reference
-------------

For details and usage examples of the code in this repository, please see the :doc:`API reference <api-reference>` page.

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

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