-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathdocumentation.html
146 lines (106 loc) · 6.41 KB
/
documentation.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
<!DOCTYPE html>
<html lang="en" data-content_root="./">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<title>Welcome to the TLO Model: Profiling Documentation — TLO Model: Profiling documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=5ecbeea2" />
<link rel="stylesheet" type="text/css" href="_static/basic.css?v=686e5160" />
<link rel="stylesheet" type="text/css" href="_static/alabaster.css?v=27fed22d" />
<script src="_static/documentation_options.js?v=5929fcd5"></script>
<script src="_static/doctools.js?v=9bcbadda"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="Profiling Runs: Lookup Page" href="index.html" />
<link rel="stylesheet" href="_static/custom.css" type="text/css" />
</head><body>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<section id="welcome-to-the-tlo-model-profiling-documentation">
<h1>Welcome to the TLO Model: Profiling Documentation<a class="headerlink" href="#welcome-to-the-tlo-model-profiling-documentation" title="Link to this heading">¶</a></h1>
<div class="toctree-wrapper compound">
<p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="index.html">Profiling Runs: Lookup Page</a></li>
<li class="toctree-l1"><a class="reference internal" href="run-statistics.html">Run Statistics</a></li>
<li class="toctree-l1"><a class="reference internal" href="developers.html">Developer Documentation</a></li>
<li class="toctree-l1"><a class="reference internal" href="api-reference.html">API Reference</a></li>
</ul>
</div>
<p>This is a repository for storing profiling outputs from the TLOmodel, an epidemiology modelling framework for the Thanzi la Onse project.</p>
<section id="running-simulations-with-the-model">
<h2>Running Simulations with the Model<a class="headerlink" href="#running-simulations-with-the-model" title="Link to this heading">¶</a></h2>
<p>For more information about setting up, using, and running simulations using the model, <a class="reference external" href="https://github.com/UCL/TLOmodel">please see the main repository</a> and information provided there.</p>
</section>
<section id="view-the-profiling-results">
<h2>View the Profiling Results<a class="headerlink" href="#view-the-profiling-results" title="Link to this heading">¶</a></h2>
<p>Profiling results are hosted on <a class="reference external" href="http://github-pages.ucl.ac.uk/TLOmodel-profiling">GitHub pages</a> and are built using <code class="docutils literal notranslate"><span class="pre">sphinx</span></code> and some custom Python scripts to process the results data.</p>
<ul class="simple">
<li><p><a class="reference internal" href="index.html"><span class="doc">Lookup table for profiling runs</span></a></p></li>
<li><p><a class="reference internal" href="run-statistics.html"><span class="doc">Summary page for captured run statistics</span></a></p></li>
</ul>
</section>
<section id="developer-documentation">
<h2>Developer Documentation<a class="headerlink" href="#developer-documentation" title="Link to this heading">¶</a></h2>
<p>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, <a class="reference internal" href="developers.html"><span class="doc">please see the online documentation</span></a>.</p>
</section>
<section id="api-reference">
<h2>API Reference<a class="headerlink" href="#api-reference" title="Link to this heading">¶</a></h2>
<p>For details and usage examples of the code in this repository, please see the <a class="reference internal" href="api-reference.html"><span class="doc">API reference</span></a> page.</p>
</section>
</section>
<section id="indices-and-tables">
<h1>Indices and tables<a class="headerlink" href="#indices-and-tables" title="Link to this heading">¶</a></h1>
<ul class="simple">
<li><p><a class="reference internal" href="genindex.html"><span class="std std-ref">Index</span></a></p></li>
<li><p><a class="reference internal" href="search.html"><span class="std std-ref">Search Page</span></a></p></li>
</ul>
</section>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="Main">
<div class="sphinxsidebarwrapper">
<h1 class="logo"><a href="#">TLO Model: Profiling</a></h1>
<search id="searchbox" style="display: none" role="search">
<div class="searchformwrapper">
<form class="search" action="search.html" method="get">
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false" placeholder="Search"/>
<input type="submit" value="Go" />
</form>
</div>
</search>
<script>document.getElementById('searchbox').style.display = "block"</script><h3>Navigation</h3>
<p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="index.html">Profiling Runs: Lookup Page</a></li>
<li class="toctree-l1"><a class="reference internal" href="run-statistics.html">Run Statistics</a></li>
<li class="toctree-l1"><a class="reference internal" href="developers.html">Developer Documentation</a></li>
<li class="toctree-l1"><a class="reference internal" href="api-reference.html">API Reference</a></li>
</ul>
<div class="relations">
<h3>Related Topics</h3>
<ul>
<li><a href="#">Documentation overview</a><ul>
<li>Next: <a href="index.html" title="next chapter">Profiling Runs: Lookup Page</a></li>
</ul></li>
</ul>
</div>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="footer">
©2023, Thanzi la Onse.
|
Powered by <a href="https://www.sphinx-doc.org/">Sphinx 8.1.3</a>
& <a href="https://alabaster.readthedocs.io">Alabaster 1.0.0</a>
|
<a href="_sources/documentation.rst.txt"
rel="nofollow">Page source</a>
</div>
</body>
</html>