-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathtutorial.html
154 lines (144 loc) · 8.26 KB
/
tutorial.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
147
148
149
150
151
152
153
154
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
<title>QHG Tutorial — QHG4 4.1 documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
<link rel="stylesheet" type="text/css" href="_static/jody.css" />
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
<script src="_static/doctools.js"></script>
<link rel="shortcut icon" href="http://aim-bigfoot.uzh.ch/~QHG/pmwiki/pub/skins/sinorca/gfx/favicon.png"/>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="QHG Tutorial 01 - A Static Population" href="tutorial/tutorial_01_static.html" />
<link rel="prev" title="QDF2PNGNew" href="tools/QDF2PNGNew.html" />
</head><body>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="tutorial/tutorial_01_static.html" title="QHG Tutorial 01 - A Static Population"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="tools/QDF2PNGNew.html" title="QDF2PNGNew"
accesskey="P">previous</a> |</li>
<li class="nav-item nav-item-0"><a href="index.html">QHG4 4.1 documentation</a> »</li>
<li class="nav-item nav-item-this"><a href="">QHG Tutorial</a></li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<section id="qhg-tutorial">
<span id="tutorial-ref"></span><h1>QHG Tutorial<a class="headerlink" href="#qhg-tutorial" title="Permalink to this heading">¶</a></h1>
<p>This tutorial explains how to implement populations, and how to compile and run QHG for them.</p>
<section id="preparations">
<h2>Preparations<a class="headerlink" href="#preparations" title="Permalink to this heading">¶</a></h2>
<p>We assume you have downloaded the code for QHG4.</p>
<p>Make sure the environmental variable QHG4_DIR contains the full path to the top directory of QHG.</p>
<p>Next create a small directory tree for the tutorials in which all subdirectories contain the necessary data for one tutorial chapter.
To do this, use the script <a class="reference internal" href="tools/build_tut_dirs.html#build-tut-dirs-ref"><span class="std std-ref">build_tut_dirs.py</span></a>.</p>
<div class="highlight-c++ notranslate"><div class="highlight"><pre><span></span><span class="n">$</span><span class="p">{</span><span class="n">QHG4_DIR</span><span class="p">}</span><span class="o">/</span><span class="n">useful_stuff</span><span class="o">/</span><span class="n">build_tut_dirs</span><span class="p">.</span><span class="n">py</span><span class="w"> </span><span class="n">tutorial</span><span class="w"></span>
</pre></div>
</div>
<p>This will build the tutorial tree in the directory from which you call the script. Alternatively use a full path:</p>
<div class="highlight-c++ notranslate"><div class="highlight"><pre><span></span><span class="n">$</span><span class="p">{</span><span class="n">QHG4_DIR</span><span class="p">}</span><span class="o">/</span><span class="n">useful_stuff</span><span class="o">/</span><span class="n">build_tut_dirs</span><span class="p">.</span><span class="n">py</span><span class="w"> </span><span class="o">/</span><span class="n">data</span><span class="o">/</span><span class="n">QHG4</span><span class="o">/</span><span class="n">tutorial</span><span class="w"></span>
</pre></div>
</div>
<p>In the tutorial we will refer to the directory you specified here as “top tutorial directory”</p>
</section>
<section id="tutorials">
<h2>Tutorials<a class="headerlink" href="#tutorials" title="Permalink to this heading">¶</a></h2>
<p>In each chapter the code of increasingly complex population classes is described in detail.</p>
<p>All populations used in QHG are derived from <a class="reference internal" href="code_doc/core/SPopulation.html#spopulation-ref"><span class="std std-ref">SPopulation</span></a>. The population classes usually have a constructor and override one or more methods.</p>
<p>must set QHG4_DIR to QHG root directory</p>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="tutorial/tutorial_01_static.html">QHG Tutorial 01 - A Static Population</a></li>
<li class="toctree-l1"><a class="reference internal" href="tutorial/tutorial_02_oldagedie.html">QHG Tutorial 02 - Aging and Death</a></li>
<li class="toctree-l1"><a class="reference internal" href="tutorial/tutorial_03_move.html">QHG Tutorial 03 - Moving</a></li>
<li class="toctree-l1"><a class="reference internal" href="tutorial/tutorial_04_partheno.html">QHG Tutorial 04 - Parthenogenesis</a></li>
<li class="toctree-l1"><a class="reference internal" href="tutorial/tutorial_05_sexual.html">QHG Tutorial 05 - Sexual Reproduction</a></li>
<li class="toctree-l1"><a class="reference internal" href="tutorial/tutorial_06_environalt.html">QHG Tutorial 06 - Environment Interaction I</a></li>
<li class="toctree-l1"><a class="reference internal" href="tutorial/tutorial_07_environcapalt.html">QHG Tutorial 07 - Environment interaction II</a></li>
</ul>
</div>
</section>
</section>
<div class="clearer"></div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<div>
<h3><a href="index.html">Table of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">QHG Tutorial</a><ul>
<li><a class="reference internal" href="#preparations">Preparations</a></li>
<li><a class="reference internal" href="#tutorials">Tutorials</a></li>
</ul>
</li>
</ul>
</div>
<div>
<h4>Previous topic</h4>
<p class="topless"><a href="tools/QDF2PNGNew.html"
title="previous chapter">QDF2PNGNew</a></p>
</div>
<div>
<h4>Next topic</h4>
<p class="topless"><a href="tutorial/tutorial_01_static.html"
title="next chapter">QHG Tutorial 01 - A Static Population</a></p>
</div>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/tutorial.rst.txt"
rel="nofollow">Show Source</a></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
<h3 id="searchlabel">Quick search</h3>
<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"/>
<input type="submit" value="Go" />
</form>
</div>
</div>
<script>document.getElementById('searchbox').style.display = "block"</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="tutorial/tutorial_01_static.html" title="QHG Tutorial 01 - A Static Population"
>next</a> |</li>
<li class="right" >
<a href="tools/QDF2PNGNew.html" title="QDF2PNGNew"
>previous</a> |</li>
<li class="nav-item nav-item-0"><a href="index.html">QHG4 4.1 documentation</a> »</li>
<li class="nav-item nav-item-this"><a href="">QHG Tutorial</a></li>
</ul>
</div>
<div class="footer" role="contentinfo">
© Copyright 2022, jodyxha.
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 5.1.1.
</div>
</body>
</html>