/usr/share/doc/xmds2/introduction.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 | <!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>Introduction — 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="index.html" />
<link rel="next" title="Installation" href="installation.html" />
<link rel="prev" title="Welcome to XMDS2!" 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="right" >
<a href="installation.html" title="Installation"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="index.html" title="Welcome to XMDS2!"
accesskey="P">previous</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="introduction">
<h1>Introduction<a class="headerlink" href="#introduction" title="Permalink to this headline">ΒΆ</a></h1>
<p>Welcome to <strong>XMDS2</strong> (codenamed <cite>xpdeint</cite>), which is an all-new version of <a class="reference internal" href="#xmdshistory"><span>XMDS</span></a>. Prepare for fast, easily-extended simulations with minimal code error.</p>
<p><strong>Description:</strong> The purpose of XMDS2 is to simplify the process of creating simulations that solve systems of initial-value first-order partial and ordinary differential equations. Instead of going through the error-prone process of writing by hand thousands of lines of code, XMDS2 enables many problems to be described in a simple XML format. From this XML description XMDS2 writes a C++ simulation that solves the problem using fast algorithms. Anecdotally, the code generated by XMDS2 is as fast as, or faster than, code hand-written by an expert, but by using XMDS2 the time taken to produce the simulation is significantly reduced.</p>
<p>XMDS2 can be used to simulate almost any set of (coupled) (partial) (stochastic) differential equations in any number of dimensions. It can input and output data in a range of data formats, produce programs that can take command-line arguments, and produce parallelised code suitable for either modern computer architectures or distributed clusters.</p>
<p>If this is your first time with XMDS, then an ideal place to start is the <a class="reference internal" href="tutorial.html#quickstarttutorial"><span>Quickstart Tutorial</span></a>, where we will show you how to write a basic simulation. <a class="reference internal" href="installation.html#installation"><span>Installation</span></a> instructions should get you up and running and able to start playing with the large library of examples provided. The impatient will probably have good luck browsing the examples library included with the source, and the <a class="reference internal" href="worked_examples.html#workedexamples"><span>Worked Examples</span></a> in this documentation for something that looks like their intended simulation.</p>
<p>If you are upgrading from <strong>XMDS version 1.x</strong>, then after following the installation instructions (<a class="reference internal" href="installation.html#installation"><span>Installation</span></a>), you might want to have a quick read of the note for upgraders (<a class="reference internal" href="upgrade.html#upgradefromxmds1"><span>Upgrading From XMDS 1.X</span></a>). The syntax of the XML scripts has changed, but hopefully you will find the new scripts very intuitive.</p>
<p>Detailed advice on input/output issues, and ways to code more complicated simulations can be found in <a class="reference internal" href="advanced_topics.html#advancedtopics"><span>Advanced Topics</span></a>.</p>
<p>XMDS2 should be cited 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>
<p id="xmdshistory"><strong>History:</strong> <strong>XMDS</strong> was created in 1997 by Peter Drummond and Greg Collecutt, who conceived of the idea of using an XML-based code generator to simplify the process of integrating systems of equations with arbitrary dimension <a class="footnote-reference" href="#f1" id="id1">[1]</a>. The first version was written in C, and featured a very flexible, strongly convergent stochastic algorithm: the <a class="reference internal" href="reference_elements.html#si"><span>semi-implicit algorithm</span></a> <a class="footnote-reference" href="#f2" id="id2">[2]</a>. Released under a public licence, it began to receive attention across several research groups. Over the next few years several people helped add new algorithms and features.</p>
<p>In 2003, the increased scope of the package prompted a complete rewrite by Greg Collecutt (using C++), which lead to <strong>XMDS 1.0</strong>. It was placed on sourceforge, and over a dozen developers contributed from 2003-2007 to help XMDS address a wider range of problems with a range of modern algorithms and support for parallel supercomputing. The documentation and installation method was improved enabling the software to be used in a wider context, and XMDS gained many users from across the world - in Australasia, Europe, America, India and China - over a variety of disciplines.</p>
<p>In 2008 a second complete rewrite was undertaken, largely by Graham Dennis (using Cheetah templates in python), leading to the current version <strong>XMDS2</strong>. This restructuring of the internal treatment of XML elements and the generated code allowed a new range of extensions to be explored. These included possibilities such as integrating multiple fields with different dimensionality, a more general set of differential equations that can be solved efficiently, and multiple choices of transforms for transverse dimensions. This restructuring was paired with a equivalent effort to make the user experience more convenient through the use of single step installers for OS X and linux, as well as an extensive documentation and example library. Today, <strong>XMDS2</strong> has been downloaded approximately 40 000 times across 71 countries.</p>
<p class="rubric">Footnotes</p>
<table class="docutils footnote" frame="void" id="f1" rules="none">
<colgroup><col class="label" /><col /></colgroup>
<tbody valign="top">
<tr><td class="label"><a class="fn-backref" href="#id1">[1]</a></td><td>G.R.Collecutt and P.D.Drummond, <cite>Xmds: eXtensible multi-dimensional simulator</cite>, Comput. Phys. Commun. <strong>142</strong>, 219 (2001).</td></tr>
</tbody>
</table>
<table class="docutils footnote" frame="void" id="f2" rules="none">
<colgroup><col class="label" /><col /></colgroup>
<tbody valign="top">
<tr><td class="label"><a class="fn-backref" href="#id2">[2]</a></td><td>M.J.Werner and P.D.Drummond, <cite>Robust algorithms for solving stochastic partial differential equations</cite>, J. Comput. Phys. <strong>132</strong>, 312 (1997).</td></tr>
</tbody>
</table>
</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="right" >
<a href="installation.html" title="Installation"
>next</a> |</li>
<li class="right" >
<a href="index.html" title="Welcome to XMDS2!"
>previous</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>
|