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
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Developer Documentation — XMDS2 2.2.2 documentation</title>
<link rel="stylesheet" href="_static/default.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: './',
VERSION: '2.2.2',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<script type="text/javascript" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS_HTML,http://www.xmds.org/_static/mathjax-use-tex-fonts.js"></script>
<link rel="shortcut icon" href="_static/xmds_favicon.ico"/>
<link rel="top" title="XMDS2 2.2.2 documentation" href="index.html" />
<link rel="next" title="Licensing" href="licensing.html" />
<link rel="prev" title="xsil2graphics2" href="xsil2graphics2.html" />
</head>
<body>
<div class="related">
<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="licensing.html" title="Licensing"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="xsil2graphics2.html" title="xsil2graphics2"
accesskey="P">previous</a> |</li>
<li><a href="index.html">XMDS2 2.2.2 documentation</a> »</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="section" id="developer-documentation">
<span id="developerdocumentation"></span><h1>Developer Documentation<a class="headerlink" href="#developer-documentation" title="Permalink to this headline">¶</a></h1>
<p>Developers need to know more than users. For example, they need to know about the test suite, and writing test cases. They need to know how to perform a developer installation. They need to know how to edit and compile this documentation. They need a step-by-step release process.</p>
<div class="section" id="test-scripts">
<span id="testscripts"></span><span id="index-0"></span><h2>Test scripts<a class="headerlink" href="#test-scripts" title="Permalink to this headline">¶</a></h2>
<p>Every time you add a new feature and/or fix a new and exciting bug, it is a great idea to make sure that the new feature works and/or the bug stays fixed. Fortunately, it is pleasantly easy to add a test case to the testing suite.</p>
<ol class="arabic simple">
<li>Write normal XMDS script that behaves as you expect.</li>
<li>Add a <tt class="docutils literal"><span class="pre"><testing></span></tt> element to your script. You can read the description of this element and its contents below, and have a look at other testcases for examples, but the basic structure is simple:.</li>
</ol>
<pre class="literal-block">
<<a class="reference internal" href="#testingelement"><em>testing</em></a>>
<<a class="reference internal" href="#commandlineelement"><em>command_line</em></a>> <<a class="reference internal" href="#commandlineelement"><em>/command_line</em></a>>
<<a class="reference internal" href="reference_elements.html#argumentselement"><em>arguments</em></a>>
<<a class="reference internal" href="reference_elements.html#argumentelement"><em>argument</em></a> />
<<a class="reference internal" href="reference_elements.html#argumentelement"><em>argument</em></a> />
...
<<a class="reference internal" href="reference_elements.html#argumentselement"><em>/arguments</em></a>>
<<a class="reference internal" href="#inputxsilfileelement"><em>input_xsil_file</em></a> />
<<a class="reference internal" href="#xsilfileelement"><em>xsil_file</em></a>>
<<a class="reference internal" href="#momentgroupelement"><em>moment_group</em></a> />
<<a class="reference internal" href="#momentgroupelement"><em>moment_group</em></a> />
...
<<a class="reference internal" href="#xsilfileelement"><em>/xsil_file</em></a>>
<<a class="reference internal" href="#testingelement"><em>/testing</em></a>>
</pre>
<ol class="arabic simple" start="3">
<li>Put into the appropriate <tt class="docutils literal"><span class="pre">testsuite/</span></tt> directory.</li>
<li>run <tt class="docutils literal"><span class="pre">./run_tests.py</span></tt> This will automatically generate your <tt class="docutils literal"><span class="pre">_expected</span></tt> files.</li>
<li>Commit the <tt class="docutils literal"><span class="pre">.xmds</span></tt>, <tt class="docutils literal"><span class="pre">*_expected.xsil</span></tt> file and any <tt class="docutils literal"><span class="pre">*_expected*</span></tt> data files.</li>
</ol>
<div class="section" id="testing-element">
<span id="testingelement"></span><h3>Testing element<a class="headerlink" href="#testing-element" title="Permalink to this headline">¶</a></h3>
</div>
<div class="section" id="command-line-element">
<span id="commandlineelement"></span><h3>command_line element<a class="headerlink" href="#command-line-element" title="Permalink to this headline">¶</a></h3>
</div>
<div class="section" id="input-xsil-file-element">
<span id="inputxsilfileelement"></span><h3>input_xsil_file element<a class="headerlink" href="#input-xsil-file-element" title="Permalink to this headline">¶</a></h3>
</div>
<div class="section" id="xsil-file-element">
<span id="xsilfileelement"></span><h3>xsil_file element<a class="headerlink" href="#xsil-file-element" title="Permalink to this headline">¶</a></h3>
</div>
<div class="section" id="moment-group-element">
<span id="momentgroupelement"></span><h3>moment_group element<a class="headerlink" href="#moment-group-element" title="Permalink to this headline">¶</a></h3>
</div>
</div>
<div class="section" id="xmds-documentation">
<span id="userdocumentation"></span><span id="index-1"></span><h2>XMDS Documentation<a class="headerlink" href="#xmds-documentation" title="Permalink to this headline">¶</a></h2>
<p>Documentation in XMDS is written as reStructuredText files (.rst), which are then parsed into HTML files to be displayed on their website.</p>
<p>You can find the user documentation folder located <tt class="docutils literal"><span class="pre">admin/userdoc-source</span></tt>. This is where all of the .rst files are kept. If you’re wanting to add documentation to the site, you’ll need to create your own .rst file, with the name of the webpage as the filename.</p>
<p>RST is a relatively simple language, which is basically simplified HTML markup. For documentation on how to make Lists, Href Links, Embed images etc, you should check here;</p>
<p><a class="reference external" href="http://docutils.sourceforge.net/docs/user/rst/quickref.html">http://docutils.sourceforge.net/docs/user/rst/quickref.html</a>
<a class="reference external" href="http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html">http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html</a></p>
<p>However, you should easily be able to use some of the pre-existing .rst files in the project as a template to create yours.</p>
<p>Once your documentation is in this folder, it should be deployed along with the project to their website when you run create_release_version.sh, which can be found in the /Trunk/xpdeint/admin folder. If you would like to test to see what your rst file generates without running this shell script, you can use the Makefile in the userdoc-source folder, by running “make html”.</p>
<p>NOTE: Before you can run the create_release_version.sh file, there are a few packages you will need. This command uses latex to generate the XMDS2 pdf, so you’ll be needing the following packages; <tt class="docutils literal"><span class="pre">texlive-fonts-recommended</span></tt>, <tt class="docutils literal"><span class="pre">texlive-lang-cjk</span></tt>, <tt class="docutils literal"><span class="pre">texlive-latex-base</span></tt>.</p>
</div>
<div class="section" id="how-to-update-xmds2-script-validator-xml-schema">
<span id="howtoaddelementtovalidator"></span><span id="index-2"></span><h2>How to update <tt class="docutils literal"><span class="pre">XMDS2</span></tt> script validator (XML schema)<a class="headerlink" href="#how-to-update-xmds2-script-validator-xml-schema" title="Permalink to this headline">¶</a></h2>
<img alt="_images/IntroduceNewElement.png" class="align-right" src="_images/IntroduceNewElement.png" />
<p>This is a short guide to adding an element to XMDS2, so that it can be validated by the XMDS2 script validator. In this guide, the example being used will be the addition of a matrix element to the validator. The matrix will have a ‘name’ and a ‘type’ (so it can be called later, and the type is known for future reference). Each matrix will also need a ‘row’ component, and possibly an initialisation value.</p>
<p>Navigate to <tt class="docutils literal"><span class="pre">xpdeint/support/xpdeint.rnc</span></tt>. This is a RelaxNG compact file, which specifies the XML schema which is only used for issuing warnings to users about missing or extraneous XML tags / attributes. Add the following lines to the end of the file (so that it is outside all other brackets in the file):</p>
<div class="highlight-none"><div class="highlight"><pre>Matrix = element matrix {
attribute name { text }
, attribute type { text }?
, element components { text }
, element initialisation {
attribute kind { text }?
}?
}
</pre></div>
</div>
<p>Save this file, and then in the terminal navigate to the folder <tt class="docutils literal"><span class="pre">xpdeint/support/</span></tt> and run <tt class="docutils literal"><span class="pre">make</span></tt>. This updates the XML based file <tt class="docutils literal"><span class="pre">xpdeint/support/xpdeint.rng</span></tt>, which is the file the parser uses to validate elements in XMDS2. This file which is used is in RelaxNG format, but RelaxNG compact is easier to read and edit.</p>
<p>Commit both <tt class="docutils literal"><span class="pre">xpdeint/support/xpdeint.rnc</span></tt> and <tt class="docutils literal"><span class="pre">xpdeint/support/xpdeint.rng</span></tt> to the code repository.</p>
</div>
<div class="section" id="how-to-introduce-a-new-integrator-stepper-into-the-xmds2-environment">
<span id="howtoaddintegrator"></span><span id="index-3"></span><h2>How to introduce a new integrator Stepper into the XMDS2 environment<a class="headerlink" href="#how-to-introduce-a-new-integrator-stepper-into-the-xmds2-environment" title="Permalink to this headline">¶</a></h2>
<img alt="_images/IntroduceNewIntegrationTechnique.png" class="align-right" src="_images/IntroduceNewIntegrationTechnique.png" />
<p>This is a short guide to adding a new stepper containing a new mathematical technique to XMDS2, which can then be used by to integrate equations. This guide describes the logistics of introducing a new stepper and as such, the code inside the stepper template is outside the scope of this document. The new stepper which will be used in this guide will be called ‘IntegrateMethodStepper’.</p>
<p>Navigate to the <tt class="docutils literal"><span class="pre">xpdeint/Segments/Integrators</span></tt> directory. Create a file called <tt class="docutils literal"><span class="pre">IntegrateMethodStepper.tmpl</span></tt> in this directory. In this file, implement the new integration algorithm (follow the convention of existing steppers in that folder). In this same folder, open the file named <tt class="docutils literal"><span class="pre">__init__.py</span></tt> and add the following line to the bottom of the file and save it:</p>
<div class="highlight-none"><div class="highlight"><pre>import IntegrateMethodStepper
</pre></div>
</div>
<p>Navigate up until you are in the <tt class="docutils literal"><span class="pre">xpdeint</span></tt> directory. Open the file <tt class="docutils literal"><span class="pre">XMDS2Parser.py</span></tt>, and ‘find’ the algorithm map (Ctrl+F > algorithmMap works for most text editors). The mnemonic ‘IM’ will be used for our Stepper. If the stepper uses fixed step sizes, then add the following line to the algorithm map:</p>
<div class="highlight-none"><div class="highlight"><pre>'IM': (Integrators.FixedStep.FixedStep, Integrators.IntegrateMethodStepper.IntegrateMethodStepper),
</pre></div>
</div>
<p>Otherwise, if your stepper is an adaptive Stepper, add the following line:</p>
<div class="highlight-none"><div class="highlight"><pre>'IM': (Integrators.AdaptiveStep.AdaptiveStep, Integrators.IntegrateMethodStepper.IntegrateMethodStepper),
</pre></div>
</div>
<p>In the terminal, navigate to the <tt class="docutils literal"><span class="pre">xpdeint</span></tt> directory, and run make over the entire directory. ‘IM’ can now be used to specify the new Stepper as your integration algorithm inside your .xmds files, e.g.</p>
<div class="highlight-xpdeint"><div class="highlight"><pre><span class="nt"><integrate</span> <span class="na">algorithm=</span><span class="s">"IM"</span> <span class="na">interval=</span><span class="s">"5.0"</span> <span class="na">steps=</span><span class="s">"2000"</span><span class="nt">></span>
...
<span class="nt"></integrate></span>
</pre></div>
</div>
<span class="target" id="logicalbreakdownparsingprocess"></span></div>
<div class="section" id="logical-breakdown-of-xmds2-parsing-process">
<span id="index-4"></span><h2>Logical breakdown of XMDS2 Parsing Process<a class="headerlink" href="#logical-breakdown-of-xmds2-parsing-process" title="Permalink to this headline">¶</a></h2>
<p>The following information is intended to assist developers in understanding the logical process undertaken by the XMDS2 system when parsing an .xmds file. The documentation was not designed to be exhaustive, but rather to help paint a picture of part of the way XMDS2 works.</p>
<p>The flowcharts have been created in open source diagram drawing program Dia, and compiled into .png files which are displayed below. This page contains links to the original .dia files, so if you find any error in the information below (or you’d like to extend it, by adding in more information), please update the .dia files and commit them (and their compiled versions) to svn.</p>
<div class="section" id="overall-process-for-parsing-xml-file-in-xmds2">
<h3>Overall process for parsing XML file in XMDS2<a class="headerlink" href="#overall-process-for-parsing-xml-file-in-xmds2" title="Permalink to this headline">¶</a></h3>
<img alt="_images/Overall_Flowchart.png" class="align-center" src="_images/Overall_Flowchart.png" />
<p>The original .dia file can be downloaded <a class="reference external" href="_images/Overall_Flowchart.dia">here</a>.</p>
</div>
<div class="section" id="parser2-py-parses-xml-file-sub-process-3">
<h3>parser2.py parses XML file (Sub process 3)<a class="headerlink" href="#parser2-py-parses-xml-file-sub-process-3" title="Permalink to this headline">¶</a></h3>
<img alt="_images/Subprocess3_ParsingXMLFile.png" class="align-center" src="_images/Subprocess3_ParsingXMLFile.png" />
<p>You can download the original dia file <a class="reference external" href="_images/Subprocess3_ParsingXMLFile.dia">here</a>.</p>
</div>
<div class="section" id="pass-file-to-xmds2parser-to-parse-xmldocument-with-parsexmldocument-sub-process-3-4">
<h3>Pass file to XMDS2Parser to parse xmlDocument with parseXMLDocument() (Sub process 3.4)<a class="headerlink" href="#pass-file-to-xmds2parser-to-parse-xmldocument-with-parsexmldocument-sub-process-3-4" title="Permalink to this headline">¶</a></h3>
<img alt="_images/Subprocess3_4_parseXMLDocument.png" class="align-center" src="_images/Subprocess3_4_parseXMLDocument.png" />
<p>You can download the original dia file <a class="reference external" href="_images/Subprocess3_4_parseXMLDocument.dia">here</a>.</p>
</div>
<div class="section" id="parse-top-level-sequence-elements-sub-process-3-4-11">
<h3>Parse Top Level Sequence elements (Sub process 3.4.11)<a class="headerlink" href="#parse-top-level-sequence-elements-sub-process-3-4-11" title="Permalink to this headline">¶</a></h3>
<img alt="_images/Subprocess3_4_11_ParseTopLvlSeqElements.png" class="align-center" src="_images/Subprocess3_4_11_ParseTopLvlSeqElements.png" />
<p>You can download the original dia file <a class="reference external" href="_images/Subprocess3_4_11_ParseTopLvlSeqElements.dia">here</a>.</p>
</div>
<div class="section" id="parse-integrate-element-sub-process-3-4-11-2">
<h3>Parse Integrate Element (Sub process 3.4.11.2)<a class="headerlink" href="#parse-integrate-element-sub-process-3-4-11-2" title="Permalink to this headline">¶</a></h3>
<img alt="_images/Subprocess3_4_11_2_ParseIntegrateElement.png" class="align-center" src="_images/Subprocess3_4_11_2_ParseIntegrateElement.png" />
<p>You can download the original dia file <a class="reference external" href="_images/Subprocess3_4_11_2_ParseIntegrateElement.dia">here</a>.</p>
</div>
</div>
<div class="section" id="directory-layout">
<span id="index-5"></span><h2>Directory layout<a class="headerlink" href="#directory-layout" title="Permalink to this headline">¶</a></h2>
<div class="section" id="xmds2-s-code-and-templates">
<h3>XMDS2’s code and templates<a class="headerlink" href="#xmds2-s-code-and-templates" title="Permalink to this headline">¶</a></h3>
<p>All <tt class="docutils literal"><span class="pre">.tmpl</span></tt> files are Cheetah template files. These are used to generate C++ code. These templates are compiled as part of the XMDS2 build process to <tt class="docutils literal"><span class="pre">.py</span></tt> files of the same name. Do not edit the generated <tt class="docutils literal"><span class="pre">.py</span></tt> files, always edit the <tt class="docutils literal"><span class="pre">.tmpl</span></tt> files and regenerate the corresponding <tt class="docutils literal"><span class="pre">.py</span></tt> files with <tt class="docutils literal"><span class="pre">make</span></tt>.</p>
<ul>
<li><dl class="first docutils">
<dt><tt class="docutils literal"><span class="pre">xpdeint/</span></tt>:</dt>
<dd><ul class="first last">
<li><dl class="first docutils">
<dt><tt class="docutils literal"><span class="pre">Features/</span></tt>: Code for all <tt class="docutils literal"><span class="pre"><feature></span></tt> elements, such as <tt class="docutils literal"><span class="pre"><globals></span></tt> and <tt class="docutils literal"><span class="pre"><auto_vectorise></span></tt></dt>
<dd><ul class="first last simple">
<li><tt class="docutils literal"><span class="pre">Transforms/</span></tt>: Code for the Fourier and matrix-based transforms (including MPI variants).</li>
</ul>
</dd>
</dl>
</li>
<li><p class="first"><tt class="docutils literal"><span class="pre">Geometry/</span></tt>: Code for describing the geometry of simulation dimensions and domains. Includes code for <tt class="docutils literal"><span class="pre">Geometry</span></tt>, <tt class="docutils literal"><span class="pre">Field</span></tt> and all <tt class="docutils literal"><span class="pre">DimensionRepresentations</span></tt>.</p>
</li>
<li><p class="first"><tt class="docutils literal"><span class="pre">Operators/</span></tt>: Code for all <tt class="docutils literal"><span class="pre"><operator></span></tt> elements, including <tt class="docutils literal"><span class="pre">IP</span></tt>, <tt class="docutils literal"><span class="pre">EX</span></tt> and the temporal derivative operator <tt class="docutils literal"><span class="pre">DeltaA</span></tt>.</p>
</li>
<li><dl class="first docutils">
<dt><tt class="docutils literal"><span class="pre">Segments/</span></tt>: Code for all elements that can appear in a <tt class="docutils literal"><span class="pre"><segments></span></tt> tag. This includes <tt class="docutils literal"><span class="pre"><integrate></span></tt>, <tt class="docutils literal"><span class="pre"><filter></span></tt>, and <tt class="docutils literal"><span class="pre"><breakpoint></span></tt>.</dt>
<dd><ul class="first last simple">
<li><tt class="docutils literal"><span class="pre">Integrators</span></tt>: Code for fixed and adaptive integration schemes, and all steppers (e.g. <tt class="docutils literal"><span class="pre">RK4</span></tt>, <tt class="docutils literal"><span class="pre">RK45</span></tt>, <tt class="docutils literal"><span class="pre">RK9</span></tt>, etc.)</li>
</ul>
</dd>
</dl>
</li>
<li><dl class="first docutils">
<dt><tt class="docutils literal"><span class="pre">Stochastic/</span></tt>: Code for all random number generators and the random variables derived from them.</dt>
<dd><ul class="first last simple">
<li><tt class="docutils literal"><span class="pre">Generators/</span></tt>: Code for random number generators, includes <tt class="docutils literal"><span class="pre">dSFMT</span></tt>, <tt class="docutils literal"><span class="pre">POSIX</span></tt>, <tt class="docutils literal"><span class="pre">Solirte</span></tt>.</li>
<li><tt class="docutils literal"><span class="pre">RandomVariables/</span></tt>: Code for the random variables derived from the random number generators. These are the gaussian, poissonian and uniform random variables.</li>
</ul>
</dd>
</dl>
</li>
<li><p class="first"><tt class="docutils literal"><span class="pre">SimulationDrivers/</span></tt>: Code for all <tt class="docutils literal"><span class="pre"><driver></span></tt> elements. In particular, this is where the location of MPI and multi-path code.</p>
</li>
<li><p class="first"><tt class="docutils literal"><span class="pre">Vectors/</span></tt>: Code for all <tt class="docutils literal"><span class="pre"><vector></span></tt> elements, and their initialisation. This includes normal <tt class="docutils literal"><span class="pre"><vector></span></tt> elements as well as <tt class="docutils literal"><span class="pre"><computed_vector></span></tt> and <tt class="docutils literal"><span class="pre"><noise_vector></span></tt> elements.</p>
</li>
<li><p class="first"><tt class="docutils literal"><span class="pre">includes/</span></tt>: C++ header and sources files used by the generated simulations.</p>
</li>
<li><dl class="first docutils">
<dt><tt class="docutils literal"><span class="pre">support/</span></tt>: Support files</dt>
<dd><ul class="first last simple">
<li><tt class="docutils literal"><span class="pre">wscript</span></tt>: <tt class="docutils literal"><span class="pre">waf</span></tt> build script for configuring and compiling generated simulations</li>
<li><tt class="docutils literal"><span class="pre">xpdeint.rnc</span></tt>: Compact RelaxNG XML validation for XMDS scripts. This is the source file for the XML RelaxNG file <tt class="docutils literal"><span class="pre">xpdeint.rng</span></tt></li>
<li><tt class="docutils literal"><span class="pre">xpdeint.rng</span></tt>: RelaxNG XML validation for XMDS scripts. To regenerate this file from <tt class="docutils literal"><span class="pre">xpdeint.rnc</span></tt>, just run <tt class="docutils literal"><span class="pre">make</span></tt> in this directory.</li>
</ul>
</dd>
</dl>
</li>
<li><p class="first"><tt class="docutils literal"><span class="pre">waf/</span></tt>: Our included version of the Python configuration and build tool <tt class="docutils literal"><span class="pre">waf</span></tt>.</p>
</li>
<li><p class="first"><tt class="docutils literal"><span class="pre">waf_extensions/</span></tt>: <tt class="docutils literal"><span class="pre">waf</span></tt> tool for compiling Cheetah templates.</p>
</li>
<li><p class="first"><tt class="docutils literal"><span class="pre">xsil2graphics2/</span></tt>: Templates for the output formats supported by <tt class="docutils literal"><span class="pre">xsil2graphics2</span></tt>.</p>
</li>
<li><p class="first"><tt class="docutils literal"><span class="pre">wscript</span></tt>: <tt class="docutils literal"><span class="pre">waf</span></tt> build script for XMDS2 itself.</p>
</li>
<li><p class="first"><tt class="docutils literal"><span class="pre">CodeParser.py</span></tt>: Minimally parses included C++ code for handling nonlocal dimension access, IP/EX operators and IP operator validation.</p>
</li>
<li><p class="first"><tt class="docutils literal"><span class="pre">Configuration.py</span></tt>: Manages configuration and building of generated simulations.</p>
</li>
<li><p class="first"><tt class="docutils literal"><span class="pre">FriendlyPlusStyle.py</span></tt>: Sphinx plug-in to improve formatting of XMDS scripts in user documentation.</p>
</li>
<li><p class="first">This directory also contains code for the input script parser, code blocks, code indentation, and the root <tt class="docutils literal"><span class="pre">_ScriptElement</span></tt> class.</p>
</li>
</ul>
</dd>
</dl>
</li>
</ul>
</div>
<div class="section" id="support-files">
<h3>Support files<a class="headerlink" href="#support-files" title="Permalink to this headline">¶</a></h3>
<ul>
<li><dl class="first docutils">
<dt><tt class="docutils literal"><span class="pre">admin/</span></tt>: Documentation source, Linux installer and release scripts.</dt>
<dd><ul class="first last simple">
<li><tt class="docutils literal"><span class="pre">developer-doc-source/</span></tt>: source for epydoc python class documentation (generated from python code).</li>
<li><tt class="docutils literal"><span class="pre">userdoc-source/</span></tt>: source for the user documentation (results visible at www.xmds.org and xmds2.readthedocs.org).</li>
<li><tt class="docutils literal"><span class="pre">xpdeint.tmbundle/</span></tt>: TextMate support bundle for Cheetah templates and XMDS scripts</li>
</ul>
</dd>
</dl>
</li>
<li><p class="first"><tt class="docutils literal"><span class="pre">bin/</span></tt>: Executable scripts to be installed as part of XMDS2 (includes <tt class="docutils literal"><span class="pre">xmds2</span></tt> and <tt class="docutils literal"><span class="pre">xsil2graphics2</span></tt>).</p>
</li>
<li><p class="first"><tt class="docutils literal"><span class="pre">examples/</span></tt>: Example XMDS2 input scripts demonstrating most of XMDS2’s features.</p>
</li>
<li><p class="first"><tt class="docutils literal"><span class="pre">testsuite/</span></tt>: Testsuite of XMDS2 scripts. Run the testsuite by executing <tt class="docutils literal"><span class="pre">./run_tests.py</span></tt></p>
</li>
</ul>
</div>
</div>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<p class="logo"><a href="index.html">
<img class="logo" src="_static/xmds_logo.png" alt="Logo"/>
</a></p>
<h3><a href="index.html">Table Of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">Developer Documentation</a><ul>
<li><a class="reference internal" href="#test-scripts">Test scripts</a><ul>
<li><a class="reference internal" href="#testing-element">Testing element</a></li>
<li><a class="reference internal" href="#command-line-element">command_line element</a></li>
<li><a class="reference internal" href="#input-xsil-file-element">input_xsil_file element</a></li>
<li><a class="reference internal" href="#xsil-file-element">xsil_file element</a></li>
<li><a class="reference internal" href="#moment-group-element">moment_group element</a></li>
</ul>
</li>
<li><a class="reference internal" href="#xmds-documentation">XMDS Documentation</a></li>
<li><a class="reference internal" href="#how-to-update-xmds2-script-validator-xml-schema">How to update <tt class="docutils literal"><span class="pre">XMDS2</span></tt> script validator (XML schema)</a></li>
<li><a class="reference internal" href="#how-to-introduce-a-new-integrator-stepper-into-the-xmds2-environment">How to introduce a new integrator Stepper into the XMDS2 environment</a></li>
<li><a class="reference internal" href="#logical-breakdown-of-xmds2-parsing-process">Logical breakdown of XMDS2 Parsing Process</a><ul>
<li><a class="reference internal" href="#overall-process-for-parsing-xml-file-in-xmds2">Overall process for parsing XML file in XMDS2</a></li>
<li><a class="reference internal" href="#parser2-py-parses-xml-file-sub-process-3">parser2.py parses XML file (Sub process 3)</a></li>
<li><a class="reference internal" href="#pass-file-to-xmds2parser-to-parse-xmldocument-with-parsexmldocument-sub-process-3-4">Pass file to XMDS2Parser to parse xmlDocument with parseXMLDocument() (Sub process 3.4)</a></li>
<li><a class="reference internal" href="#parse-top-level-sequence-elements-sub-process-3-4-11">Parse Top Level Sequence elements (Sub process 3.4.11)</a></li>
<li><a class="reference internal" href="#parse-integrate-element-sub-process-3-4-11-2">Parse Integrate Element (Sub process 3.4.11.2)</a></li>
</ul>
</li>
<li><a class="reference internal" href="#directory-layout">Directory layout</a><ul>
<li><a class="reference internal" href="#xmds2-s-code-and-templates">XMDS2’s code and templates</a></li>
<li><a class="reference internal" href="#support-files">Support files</a></li>
</ul>
</li>
</ul>
</li>
</ul>
<div id="searchbox" style="display: none">
<h3>Quick search</h3>
<form class="search" action="search.html" method="get">
<input type="text" name="q" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
<p class="searchtip" style="font-size: 90%">
Enter search terms or a module, class or function name.
</p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related">
<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="licensing.html" title="Licensing"
>next</a> |</li>
<li class="right" >
<a href="xsil2graphics2.html" title="xsil2graphics2"
>previous</a> |</li>
<li><a href="index.html">XMDS2 2.2.2 documentation</a> »</li>
</ul>
</div>
<div class="footer">
© Copyright 2008-2014, Graham Dennis, Joe Hope and Mattias Johnsson. Licensed under the GNU FDL.
Last updated on Oct 14, 2014.
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2b1.
</div>
</body>
</html>
|
