<!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 the documentation for XMDS2! — 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="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.3 documentation" href="index.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="nav-item nav-item-0"><a href="index.html">XMDS2 2.2.3 documentation</a> »</li> </ul> </div> <div class="document"> <div class="documentwrapper"> <div class="bodywrapper"> <div class="body" role="main"> <div class="section" id="welcome-to-the-documentation-for-xmds2"> <span id="documentation"></span><h1>Welcome to the documentation for XMDS2!<a class="headerlink" href="#welcome-to-the-documentation-for-xmds2" title="Permalink to this headline">¶</a></h1> <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">‘Loose’ <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 “It came from the deep” (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 “XMDS2 is a game of two halves” (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 “XMDS2 is a game of two halves” (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 “Out of cheese error” (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 “Well if this isn’t nice, I don’t know what is” (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 “Happy Mollusc” (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 “Happy Mollusc” (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 “Happy Mollusc” (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 “Shiny!” (September 13, 2010)</a></li> </ul> </li> </ul> </div> </div> </div> </div> </div> <div class="sphinxsidebar" role="navigation" aria-label="main navigation"> <div class="sphinxsidebarwrapper"> <p class="logo"><a href="index.html"> <img class="logo" src="_static/xmds_logo.png" alt="Logo"/> </a></p> <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="nav-item nav-item-0"><a href="index.html">XMDS2 2.2.3 documentation</a> »</li> </ul> </div> <div class="footer" role="contentinfo"> © 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>