This file is indexed.

/usr/share/doc/xmds2/index.html is in xmds2-doc 2.2.3+dfsg-5.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below.

  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
<!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>Welcome to XMDS2! &mdash; XMDS2 2.2.3 documentation</title>
    
    <link rel="stylesheet" href="_static/classic.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.3',
        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="file:///usr/share/javascript/mathjax/MathJax.js?config=TeX-AMS_HTML,file:///usr/share/doc/xmds2/_static/mathjax-use-tex-fonts.js"></script>
    <link rel="shortcut icon" href="_static/xmds_favicon.ico"/>
    <link rel="top" title="XMDS2 2.2.3 documentation" href="#" />
    <link rel="next" title="Introduction" href="introduction.html" /> 
  </head>
  <body role="document">
    <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="introduction.html" title="Introduction"
             accesskey="N">next</a> |</li>
        <li class="nav-item nav-item-0"><a href="#">XMDS2 2.2.3 documentation</a> &raquo;</li> 
      </ul>
    </div>  

    <div class="document">
      <div class="documentwrapper">
        <div class="bodywrapper">
          <div class="body" role="main">
            
  <div class="section" id="welcome-to-xmds2">
<h1>Welcome to XMDS2!<a class="headerlink" href="#welcome-to-xmds2" title="Permalink to this headline"></a></h1>
<p>This website provides the documentation for XMDS2 (an all-new version of <a class="reference internal" href="introduction.html#xmdshistory"><span>XMDS</span></a>), a software package that allows the fast and easy solution of sets of ordinary, partial and stochastic differential equations, using a variety of efficient numerical algorithms.</p>
<p>If you publish work that has involved XMDS2, please cite it as <a class="reference external" href="http://dx.doi.org/10.1016/j.cpc.2012.08.016">Comput. Phys. Commun. 184, 201-208 (2013)</a>.</p>
<div class="section" id="getting-started">
<h2>Getting Started<a class="headerlink" href="#getting-started" title="Permalink to this headline"></a></h2>
<p>To get a flavour of what XMDS2 can do, take a look at our <a class="reference internal" href="tutorial.html#quickstarttutorial"><span>Quickstart Tutorial</span></a>, then take a look at our comprehensive  <a class="reference internal" href="documentation_toc.html#documentation"><span>documentation</span></a>.  Automated installers are available for Linux and Mac OS X, refer to our <a class="reference internal" href="installation.html#installation"><span>installation instructions</span></a> for details.</p>
</div>
<div class="section" id="news">
<h2>News<a class="headerlink" href="#news" title="Permalink to this headline"></a></h2>
<div class="section" id="xmds-2-2-3-it-came-from-the-deep-january-20-2017">
<h3>XMDS 2.2.3 &#8220;It came from the deep&#8221; (January 20, 2017)<a class="headerlink" href="#xmds-2-2-3-it-came-from-the-deep-january-20-2017" title="Permalink to this headline"></a></h3>
<p>XMDS 2.2.3 is primarily a maintenance release consolidating various bug fixes and small improvements that have been made. Specifically</p>
<ul class="simple">
<li>A number of bugs have been fixed</li>
<li>Remove requirement that samples must divide into steps when using an adaptive stepper</li>
<li>Make initial step size more robust when using adaptive stepper</li>
<li>Improved debug mode</li>
<li>Added extra examples</li>
<li>Documentation improvements</li>
</ul>
</div>
<div class="section" id="xmds-2-2-2-xmds2-is-a-game-of-two-halves-october-13-2014">
<h3>XMDS 2.2.2 &#8220;XMDS2 is a game of two halves&#8221; (October 13, 2014)<a class="headerlink" href="#xmds-2-2-2-xmds2-is-a-game-of-two-halves-october-13-2014" title="Permalink to this headline"></a></h3>
<p>High priority bug fixes to the previous release.</p>
</div>
<div class="section" id="xmds-2-2-1-xmds2-is-a-game-of-two-halves-september-30-2014">
<h3>XMDS 2.2.1 &#8220;XMDS2 is a game of two halves&#8221; (September 30, 2014)<a class="headerlink" href="#xmds-2-2-1-xmds2-is-a-game-of-two-halves-september-30-2014" title="Permalink to this headline"></a></h3>
<p>XMDS 2.2.1 contains minor bugfixes and updates. This includes documentation improvements, superior handling of external packages and more informative errors.</p>
</div>
<div class="section" id="xmds-2-2-0-out-of-cheese-error-january-13-2014">
<h3>XMDS 2.2.0 &#8220;Out of cheese error&#8221; (January 13, 2014)<a class="headerlink" href="#xmds-2-2-0-out-of-cheese-error-january-13-2014" title="Permalink to this headline"></a></h3>
<p>XMDS 2.2.0 contains a number of new features, as well as bugfixes and updates. Specifically</p>
<ul class="simple">
<li>Separated IP operators.  This is a significant performance optimisation (~30%) for problems with two or more dimensions.  It requires separating IP operators of the form &#8220;f(kx) + g(ky)&#8221; (e.g. kinetic energy for quantum physics) into <em>two</em> IP operators and explicitly setting the dimensions=&#8221;x&#8221; and dimensions=&#8221;y&#8221; attributes on each.  See <a class="reference internal" href="optimisation_hints.html#optimisationhints"><span>Optimisation hints</span></a> for details.</li>
<li>Significant speed optimisations for adaptive integrators with IP operators (past IP operator calculations are re-used if the time-step hasn&#8217;t changed).</li>
<li>The &#8220;constant&#8221; attribute for IP/EX operators is now unnecessary and considered advanced usage.  If you don&#8217;t know whether to specify constant=&#8221;yes&#8221; or constant=&#8221;no&#8221;, don&#8217;t specify either.</li>
<li>The xsil2graphics2 data exporter now supports Matlab, Octave, Mathematica and Python in all output formats, as well as R (HDF5 only).  The Matlab/Octave scripts are now identical.  A script generated for one will work for the other.</li>
<li>Bessel-Neumann transforms have been implemented.  Set transform=&#8221;bessel-neumann&#8221; if you want a Bessel (Hankel) transform but have zero derivative at the boundary (Neumann boundary conditions) instead of zero function value (Dirichlet boundary conditions).  If you don&#8217;t care about your boundary condition, stick with the &#8220;bessel&#8221; transform.</li>
<li>A Bulirisch-Stoer integrator.  This can be useful for problems which are very smooth as you can use an arbitrarily high order algorithm.  Specify algorithm=&#8221;RE&#8221; and extrapolations=&#8221;5&#8221; to have a 10th order integrator.  Currently this is fixed-step only.</li>
<li>&#8220;adaptive-mpi-multipath&#8221; driver.  This implements a load scheduler that better spreads the work across different CPUs when different paths can take very different amounts of time. Also useful in heterogeneous clusters.</li>
<li>XMDS2 is currently undergoing acceptance into Debian linux and will soon be able to be installed via the package manager. In the meantime you can find it in the private APT repository at <a class="reference external" href="http://xmds.laboissiere.net">http://xmds.laboissiere.net</a>.</li>
<li>A number of bug fixes.</li>
<li>Expanded and improved documentation.</li>
</ul>
<p>Many thanks to all who contributed to this release!</p>
</div>
<div class="section" id="xmds-2-1-4-well-if-this-isn-t-nice-i-don-t-know-what-is-september-27-2013">
<h3>XMDS 2.1.4 &#8220;Well if this isn&#8217;t nice, I don&#8217;t know what is&#8221; (September 27, 2013)<a class="headerlink" href="#xmds-2-1-4-well-if-this-isn-t-nice-i-don-t-know-what-is-september-27-2013" title="Permalink to this headline"></a></h3>
<p>The XMDS 2.1.4 update contains many new improvements and bugfixes:</p>
<ul class="simple">
<li><em>xsil2graphics2</em> now supports all output formats for MATLAB, Octave and Python.  The scripts generated for MATLAB/Octave are compatible with both.</li>
<li>Fix a bug when <a class="reference internal" href="reference_elements.html#referencingnonlocal"><span>nonlocally</span></a> referencing a <a class="reference internal" href="advanced_topics.html#dimensionaliases"><span>dimension alias</span></a> with subsampling in <em>sampling_group</em> blocks or in some situations when MPI is used.  This bug caused incorrect elements of the vector to be accessed.</li>
<li>Correct the Fourier basis for dimensions using Hermite-Gauss transforms.  Previously &#8216;kx&#8217; was effectively behaving as &#8216;-kx&#8217;.</li>
<li>Improve the performance of &#8216;nx&#8217; &lt;&#8211;&gt; &#8216;kx&#8217; Hermite-Gauss transforms.</li>
<li>Stochastic error checking with runtime noise generation now works correctly.  Previously different random numbers were generated for the full-step paths and the half-step paths.</li>
<li>Documentation updates.</li>
</ul>
</div>
<div class="section" id="xmds-2-1-3-happy-mollusc-june-7-2013">
<h3>XMDS 2.1.3 &#8220;Happy Mollusc&#8221; (June 7, 2013)<a class="headerlink" href="#xmds-2-1-3-happy-mollusc-june-7-2013" title="Permalink to this headline"></a></h3>
<p>The XMDS 2.1.3 update is a bugfix release that includes the following improvements:</p>
<ul class="simple">
<li>XMDS will work when MPI isn&#8217;t installed (but only for single-process simulations).</li>
<li>Support for GCC 4.8</li>
<li>The number of paths used by the multi-path driver can now be specified at run-time (using <em>&lt;validation kind=&#8221;run-time&#8221;&gt;</em>)</li>
<li>Other bug fixes</li>
</ul>
</div>
<div class="section" id="xmds-2-1-2-happy-mollusc-october-15-2012">
<h3>XMDS 2.1.2 &#8220;Happy Mollusc&#8221; (October 15, 2012)<a class="headerlink" href="#xmds-2-1-2-happy-mollusc-october-15-2012" title="Permalink to this headline"></a></h3>
<p>The XMDS 2.1.2 update has many improvements:</p>
<ul class="simple">
<li>Named filters.  You can now specify a name for a filter block and call it like a function if you need to execute it conditionally.  See the documentation for the <em>&lt;filter&gt;</em> block for more information.</li>
<li>New <em>chunked_output</em> feature.  XMDS can now output simulation results as it goes, reducing the memory requirement for simulations that generate significant amounts of output.  See the documentation for more details.</li>
<li>Improved OpenMP support</li>
<li>The EX operator is now faster in the common case (but you should still prefer IP when possible)</li>
<li>If seeds are not provided for a <em>noise_vector</em>, they are now generated at simulation run-time, so different executions will give different results.  The generated noises can still be found in the output .xsil files enabling results to be reproduced if desired.</li>
<li>Advanced feature: Dimensions can be accessed non-locally with the index of the lattice point.  This removes the need in hacks to manually access XMDS&#8217;s underlying C arrays.  This is an advanced feature and requires a little knowledge of XMDS&#8217;s internal grid representation.  See the advanced topics documentation for further details.</li>
<li>Fixed adaptive integrator order when noises were used in vector initialisation</li>
<li>Fix the Spherical Bessel basis.  There were errors in the definition of this basis which made it previously unreliable.</li>
<li>Other bug fixes</li>
</ul>
</div>
<div class="section" id="xmds-2-1-happy-mollusc-june-14-2012">
<h3>XMDS 2.1 &#8220;Happy Mollusc&#8221; (June 14, 2012)<a class="headerlink" href="#xmds-2-1-happy-mollusc-june-14-2012" title="Permalink to this headline"></a></h3>
<p>XMDS 2.1 is a significant upgrade with many improvements and bug fixes since 2.0. We also now have installers for Linux and Mac OS X, so you no longer have to build XMDS from source! See <a class="reference internal" href="installation.html#installation"><span>here</span></a> for details about the installers.</p>
<p>Existing users should note that this release introduces a more concise syntax for moment groups.  You can now use:</p>
<div class="highlight-xmds2"><div class="highlight"><pre><span class="nt">&lt;sampling_group</span> <span class="na">initial_sample=</span><span class="s">&quot;yes&quot;</span> <span class="na">basis=</span><span class="s">&quot;x y z&quot;</span><span class="nt">&gt;</span>
    ...
<span class="nt">&lt;/sampling_group&gt;</span>
</pre></div>
</div>
<p>Instead of:</p>
<div class="highlight-xmds2"><div class="highlight"><pre><span class="nt">&lt;group&gt;</span>
    <span class="nt">&lt;sampling</span> <span class="na">initial_sample=</span><span class="s">&quot;yes&quot;</span> <span class="na">basis=</span><span class="s">&quot;x y z&quot;</span><span class="nt">&gt;</span>
        ...
    <span class="nt">&lt;/sampling&gt;</span>
<span class="nt">&lt;/group&gt;</span>
</pre></div>
</div>
<p>Another syntax change is that the initial basis of a vector should be specified with <em>initial_basis</em> instead of <em>initial_space</em>.</p>
<p>In both cases, although the old syntax is not described in the documentation, it is still supported, so existing scripts will work without any changes.</p>
<p>Other changes in XMDS 2.1 include:</p>
<ul class="simple">
<li>The <em>lattice</em> attribute for dimensions can now be specified at run-time.  Previously only the minimum and maximum values of the domain could be specified at run-time.  See <a class="reference internal" href="reference_elements.html#validation"><span>here</span></a> for details.</li>
<li><em>noise_vectors</em> can now be used in non-uniform dimensions (e.g. dimensions using the Bessel transform for cylindrical symmetry).</li>
<li>&#8220;loose&#8221; <em>geometry_matching_mode</em> for HDF5 vector initialisation.  This enables extending the simulation grid from one simulation to the next, or coarsening or refining a grid when importing.</li>
<li><em>vectors</em> can now be initialised by integrating over dimensions of other vectors.  <em>computed_vectors</em> always supported this, now <em>vectors</em> do too.</li>
<li>Update to latest version of waf, which is used for compiling simulations and detecting FFTW, HDF5, etc. This should lead to fewer waf-related problems.</li>
<li>Bug fixes.</li>
</ul>
</div>
<div class="section" id="xmds-2-0-shiny-september-13-2010">
<h3>XMDS 2.0 &#8220;Shiny!&#8221; (September 13, 2010)<a class="headerlink" href="#xmds-2-0-shiny-september-13-2010" title="Permalink to this headline"></a></h3>
<p>XMDS 2.0 is a major upgrade which has been rewritten from the ground up to make it easier for us to apply new features. And there are many. XMDS 2.0 is faster and far more versatile than previous versions, allowing the efficient integration of almost any initial value problem on regular domains.</p>
<p>The feature list includes:</p>
<ul class="simple">
<li>Quantities of different dimensionalities. So you can have a 1D potential and a 3D wavefunction.</li>
<li>Integrate more than one vector (in more than one geometry), so you can now simultaneously integrate a PDE and a coupled ODE (or coupled PDEs of different dimensions).</li>
<li>Non-Fourier transformations including the Bessel basis, Spherical Bessel basis and the Hermite-Gauss (harmonic oscillator) basis.</li>
<li>The ability to have more than one kind of noise (gaussian, poissonian, etc) in a simulation.</li>
<li>Integer-valued dimensions with non-local access. You can have an array of variables and access different elements of that array.</li>
<li>Significantly better error reporting. When errors are found when compiling the script they will almost always be reported with the corresponding line of your script, instead of the generated source.</li>
<li><em>IP</em>/<em>EX</em> operators are separate from the integration algorithm, so you can have both <em>IP</em> and <em>EX</em> operators in a single integrate block. Also, <em>EX</em> operators can act on arbitrary code, not just vector components. (e.g. <em>L[phi*phi]</em>).</li>
<li>Cross propagation in the increasing direction of a given dimension or in the decreasing dimension. And you can have more than one cross-propagator in a given integrator (going in different directions or dimensions).</li>
<li>Faster Gaussian noises.</li>
<li>The ability to calculate spatial correlation functions.</li>
<li>OpenMP support.</li>
<li>MPI support.</li>
<li>Output moment groups use less memory when there isn&#8217;t a <em>post_processing</em> element.</li>
<li>Generated source is indented correctly.</li>
<li>An <em>xmds1</em>-like script file format.</li>
<li><em>xmds1</em>-like generated source.</li>
<li>All of the integrators from <em>xmds1</em> (<em>SI</em>, <em>RK4</em>, <em>ARK45</em>, <em>RK9</em>, <em>ARK89</em>).</li>
</ul>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction</a></li>
<li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a><ul>
<li class="toctree-l2"><a class="reference internal" href="installation.html#installers">Installers</a></li>
<li class="toctree-l2"><a class="reference internal" href="installation.html#linux-installer-instructions">Linux installer instructions</a></li>
<li class="toctree-l2"><a class="reference internal" href="installation.html#mac-os-x-installation">Mac OS X Installation</a></li>
<li class="toctree-l2"><a class="reference internal" href="installation.html#manual-installation-from-source">Manual installation from source</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="tutorial.html">Quickstart Tutorial</a></li>
<li class="toctree-l1"><a class="reference internal" href="worked_examples.html">Worked Examples</a><ul>
<li class="toctree-l2"><a class="reference internal" href="worked_examples.html#the-nonlinear-schrodinger-equation">The nonlinear Schrödinger equation</a></li>
<li class="toctree-l2"><a class="reference internal" href="worked_examples.html#kubo-oscillator">Kubo Oscillator</a></li>
<li class="toctree-l2"><a class="reference internal" href="worked_examples.html#fibre-noise">Fibre Noise</a></li>
<li class="toctree-l2"><a class="reference internal" href="worked_examples.html#integer-dimensions">Integer Dimensions</a></li>
<li class="toctree-l2"><a class="reference internal" href="worked_examples.html#wigner-function">Wigner Function</a></li>
<li class="toctree-l2"><a class="reference internal" href="worked_examples.html#finding-the-ground-state-of-a-bec-continuous-renormalisation">Finding the Ground State of a BEC (continuous renormalisation)</a></li>
<li class="toctree-l2"><a class="reference internal" href="worked_examples.html#finding-the-ground-state-of-a-bec-again">Finding the Ground State of a BEC again</a></li>
<li class="toctree-l2"><a class="reference internal" href="worked_examples.html#multi-component-schrodinger-equation">Multi-component Schrödinger equation</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="reference_index.html">Reference section</a><ul>
<li class="toctree-l2"><a class="reference internal" href="reference_installation_and_configuration.html">Configuration, installation and runtime options</a></li>
<li class="toctree-l2"><a class="reference internal" href="reference_usefulXMLSyntax.html">Useful XML Syntax</a></li>
<li class="toctree-l2"><a class="reference internal" href="reference_schema.html">XMDS2 XML Schema</a></li>
<li class="toctree-l2"><a class="reference internal" href="reference_elements.html">XMDS2 script elements</a></li>
<li class="toctree-l2"><a class="reference internal" href="bulirschStoer.html">Modified Midpoint Method</a></li>
<li class="toctree-l2"><a class="reference internal" href="bulirschStoer.html#bulirsch-stoer-algorithm">Bulirsch-Stoer Algorithm</a></li>
<li class="toctree-l2"><a class="reference internal" href="bulirschStoer.html#error-scaling-behaviour">Error Scaling Behaviour</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="advanced_topics.html">Advanced Topics</a><ul>
<li class="toctree-l2"><a class="reference internal" href="advanced_topics.html#importing-data">Importing data</a></li>
<li class="toctree-l2"><a class="reference internal" href="advanced_topics.html#convolutions-and-fourier-transforms">Convolutions and Fourier transforms</a></li>
<li class="toctree-l2"><a class="reference internal" href="advanced_topics.html#loose-geometry-matching-mode">&#8216;Loose&#8217; <code class="docutils literal"><span class="pre">geometry_matching_mode</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="advanced_topics.html#dimension-aliases">Dimension aliases</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="faq.html">Frequently Asked Questions</a><ul>
<li class="toctree-l2"><a class="reference internal" href="faq.html#xmds-scripts-look-complicated-how-do-i-start">XMDS scripts look complicated! How do I start?</a></li>
<li class="toctree-l2"><a class="reference internal" href="faq.html#where-can-i-get-help">Where can I get help?</a></li>
<li class="toctree-l2"><a class="reference internal" href="faq.html#how-should-i-cite-xmds2">How should I cite XMDS2?</a></li>
<li class="toctree-l2"><a class="reference internal" href="faq.html#i-think-i-found-a-bug-where-should-i-report-it">I think I found a bug! Where should I report it?</a></li>
<li class="toctree-l2"><a class="reference internal" href="faq.html#how-do-i-put-time-dependence-into-my-vectors">How do I put time dependence into my vectors?</a></li>
<li class="toctree-l2"><a class="reference internal" href="faq.html#can-i-specify-the-range-of-my-domain-and-number-of-grid-points-at-run-time">Can I specify the range of my domain and number of grid points at run-time?</a></li>
<li class="toctree-l2"><a class="reference internal" href="faq.html#when-can-i-use-ip-operators-and-why-should-i-and-when-must-i-use-ex-operators">When can I use IP operators (and why should I) and when must I use EX operators?</a></li>
<li class="toctree-l2"><a class="reference internal" href="faq.html#visual-editors">Visual Editors</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="upgrade.html">Upgrading From XMDS 1.X</a></li>
<li class="toctree-l1"><a class="reference internal" href="optimisation_hints.html">Optimisation Hints</a><ul>
<li class="toctree-l2"><a class="reference internal" href="optimisation_hints.html#geometry-and-transform-based-tricks">Geometry and transform-based tricks</a></li>
<li class="toctree-l2"><a class="reference internal" href="optimisation_hints.html#reduce-code-complexity">Reduce code complexity</a></li>
<li class="toctree-l2"><a class="reference internal" href="optimisation_hints.html#compiler-and-library-tricks">Compiler and library tricks</a></li>
<li class="toctree-l2"><a class="reference internal" href="optimisation_hints.html#atom-optics-specific-hints">Atom-optics-specific hints</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="xsil2graphics2.html">xsil2graphics2</a></li>
<li class="toctree-l1"><a class="reference internal" href="developer.html">Developer Documentation</a><ul>
<li class="toctree-l2"><a class="reference internal" href="developer.html#test-scripts">Test scripts</a></li>
<li class="toctree-l2"><a class="reference internal" href="developer.html#xmds-documentation">XMDS Documentation</a></li>
<li class="toctree-l2"><a class="reference internal" href="developer.html#how-to-update-xmds2-script-validator-xml-schema">How to update <code class="docutils literal"><span class="pre">XMDS2</span></code> script validator (XML schema)</a></li>
<li class="toctree-l2"><a class="reference internal" href="developer.html#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 class="toctree-l2"><a class="reference internal" href="developer.html#logical-breakdown-of-xmds2-parsing-process">Logical breakdown of XMDS2 Parsing Process</a></li>
<li class="toctree-l2"><a class="reference internal" href="developer.html#directory-layout">Directory layout</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="licensing.html">Licensing</a><ul>
<li class="toctree-l2"><a class="reference internal" href="licensing.html#gnu-general-public-license">GNU General Public License</a></li>
<li class="toctree-l2"><a class="reference internal" href="licensing.html#gnu-free-documentation-license">GNU Free Documentation License</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="news.html">News</a><ul>
<li class="toctree-l2"><a class="reference internal" href="news.html#xmds-2-2-3-it-came-from-the-deep-january-20-2017">XMDS 2.2.3 &#8220;It came from the deep&#8221; (January 20, 2017)</a></li>
<li class="toctree-l2"><a class="reference internal" href="news.html#xmds-2-2-2-xmds2-is-a-game-of-two-halves-october-13-2014">XMDS 2.2.2 &#8220;XMDS2 is a game of two halves&#8221; (October 13, 2014)</a></li>
<li class="toctree-l2"><a class="reference internal" href="news.html#xmds-2-2-1-xmds2-is-a-game-of-two-halves-september-30-2014">XMDS 2.2.1 &#8220;XMDS2 is a game of two halves&#8221; (September 30, 2014)</a></li>
<li class="toctree-l2"><a class="reference internal" href="news.html#xmds-2-2-0-out-of-cheese-error-january-13-2014">XMDS 2.2.0 &#8220;Out of cheese error&#8221; (January 13, 2014)</a></li>
<li class="toctree-l2"><a class="reference internal" href="news.html#xmds-2-1-4-well-if-this-isn-t-nice-i-don-t-know-what-is-september-27-2013">XMDS 2.1.4 &#8220;Well if this isn&#8217;t nice, I don&#8217;t know what is&#8221; (September 27, 2013)</a></li>
<li class="toctree-l2"><a class="reference internal" href="news.html#xmds-2-1-3-happy-mollusc-june-7-2013">XMDS 2.1.3 &#8220;Happy Mollusc&#8221; (June 7, 2013)</a></li>
<li class="toctree-l2"><a class="reference internal" href="news.html#xmds-2-1-2-happy-mollusc-october-15-2012">XMDS 2.1.2 &#8220;Happy Mollusc&#8221; (October 15, 2012)</a></li>
<li class="toctree-l2"><a class="reference internal" href="news.html#xmds-2-1-happy-mollusc-june-14-2012">XMDS 2.1 &#8220;Happy Mollusc&#8221; (June 14, 2012)</a></li>
<li class="toctree-l2"><a class="reference internal" href="news.html#xmds-2-0-shiny-september-13-2010">XMDS 2.0 &#8220;Shiny!&#8221; (September 13, 2010)</a></li>
</ul>
</li>
</ul>
</div>
</div>
</div>
</div>


          </div>
        </div>
      </div>
      <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
        <div class="sphinxsidebarwrapper">
            <p class="logo"><a href="#">
              <img class="logo" src="_static/xmds_logo.png" alt="Logo"/>
            </a></p>
<h3><a href="#">Table Of Contents</a></h3>
<ul>
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction</a></li>
<li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="tutorial.html">Quickstart Tutorial</a></li>
<li class="toctree-l1"><a class="reference internal" href="worked_examples.html">Worked Examples</a></li>
<li class="toctree-l1"><a class="reference internal" href="reference_index.html">Reference section</a></li>
<li class="toctree-l1"><a class="reference internal" href="advanced_topics.html">Advanced Topics</a></li>
<li class="toctree-l1"><a class="reference internal" href="faq.html">Frequently Asked Questions</a></li>
<li class="toctree-l1"><a class="reference internal" href="upgrade.html">Upgrading From XMDS 1.X</a></li>
<li class="toctree-l1"><a class="reference internal" href="optimisation_hints.html">Optimisation Hints</a></li>
<li class="toctree-l1"><a class="reference internal" href="xsil2graphics2.html">xsil2graphics2</a></li>
<li class="toctree-l1"><a class="reference internal" href="developer.html">Developer Documentation</a></li>
<li class="toctree-l1"><a class="reference internal" href="licensing.html">Licensing</a></li>
<li class="toctree-l1"><a class="reference internal" href="news.html">News</a></li>
</ul>

<div id="searchbox" style="display: none" role="search">
  <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" 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="introduction.html" title="Introduction"
             >next</a> |</li>
        <li class="nav-item nav-item-0"><a href="#">XMDS2 2.2.3 documentation</a> &raquo;</li> 
      </ul>
    </div>
    <div class="footer" role="contentinfo">
        &copy; Copyright 2008-2014, Graham Dennis, Joe Hope and Mattias Johnsson. Licensed under the GNU FDL.
      Last updated on Jan 21, 2017.
      Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.3.6.
    </div>
  </body>
</html>