File: reference_installation_and_configuration.html

package info (click to toggle)
xmds2 3.0.0%2Bdfsg-5
  • links: PTS, VCS
  • area: main
  • in suites: bullseye
  • size: 52,068 kB
  • sloc: python: 63,652; javascript: 9,230; cpp: 3,929; ansic: 1,463; makefile: 121; sh: 54
file content (131 lines) | stat: -rw-r--r-- 7,960 bytes parent folder | download
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

<!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>Configuration, installation and runtime options &#8212; XMDS2 3.0.0 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:     '3.0.0',
        COLLAPSE_INDEX: false,
        FILE_SUFFIX: '.html',
        HAS_SOURCE:  true,
        SOURCELINK_SUFFIX: '.txt'
      };
    </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="index" title="Index" href="genindex.html" />
    <link rel="search" title="Search" href="search.html" />
    <link rel="next" title="Useful XML Syntax" href="reference_usefulXMLSyntax.html" />
    <link rel="prev" title="Reference section" href="reference_index.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="reference_usefulXMLSyntax.html" title="Useful XML Syntax"
             accesskey="N">next</a> |</li>
        <li class="right" >
          <a href="reference_index.html" title="Reference section"
             accesskey="P">previous</a> |</li>
        <li class="nav-item nav-item-0"><a href="index.html">XMDS2 3.0.0 documentation</a> &#187;</li>
          <li class="nav-item nav-item-1"><a href="reference_index.html" accesskey="U">Reference section</a> &#187;</li> 
      </ul>
    </div>  

    <div class="document">
      <div class="documentwrapper">
        <div class="bodywrapper">
          <div class="body" role="main">
            
  <p>:: index:: Configure, Reconfigure, XMDS2 runtime options</p>
<div class="section" id="configuration-installation-and-runtime-options">
<span id="referenceconfigurationinstallationruntime"></span><h1>Configuration, installation and runtime options<a class="headerlink" href="#configuration-installation-and-runtime-options" title="Permalink to this headline">¶</a></h1>
<dl class="docutils">
<dt>Running the ‘xmds2’ program with the option ‘–help’, gives several options that can change its behaviour at runtime.  These include:</dt>
<dd><ul class="first last simple">
<li>‘-o’ or ‘–output’, which overrides the name of the output file to be generated</li>
<li>‘-n’ or ‘–no-compile’, which generates the C code for the simulation, but does not try to compile it</li>
<li>‘-v’ or ‘–verbose’, which gives verbose output about compilation flags.</li>
<li>‘-g’ or ‘–debug’, which compiles the simulation in debug mode (compilation errors refer to lines in the source, not the .xmds file). This option implies ‘-v’. This option is mostly useful when debugging XMDS code generation.</li>
<li>‘–waf-verbose’, which makes <code class="docutils literal"><span class="pre">waf</span></code> be very verbose when configuring XMDS or compiling simulations.  This option is intended for developer use only to aid in diagnosing problems with <code class="docutils literal"><span class="pre">waf</span></code>.</li>
</ul>
</dd>
</dl>
<p>It also has commands to configure XMDS2 and recheck the installation.  If your program requires extra paths to compile, you can configure XMDS2 to include those paths by default.  Simply use the command</p>
<div class="highlight-bash"><div class="highlight"><pre><span></span>$ xmds2 --configure --include-path /path/to/include --lib-path /path/to/lib
</pre></div>
</div>
<p>Alternatively, you can set the <code class="docutils literal"><span class="pre">CXXFLAGS</span></code> or <code class="docutils literal"><span class="pre">LINKFLAGS</span></code> environment variables before calling <code class="docutils literal"><span class="pre">xmds2</span> <span class="pre">--reconfigure</span></code>.  For example, to pass the compiler flag <code class="docutils literal"><span class="pre">-pedantic</span></code> and the link flag <code class="docutils literal"><span class="pre">-lm</span></code> using the bash shell, use:</p>
<div class="highlight-bash"><div class="highlight"><pre><span></span>$ <span class="nb">export</span> <span class="nv">CXXFLAGS</span><span class="o">=</span><span class="s2">&quot;-pedantic&quot;</span>
$ <span class="nb">export</span> <span class="nv">LINKFLAGS</span><span class="o">=</span><span class="s2">&quot;-lm&quot;</span>
$ xmds2 --reconfigure<span class="sb">``</span>
</pre></div>
</div>
<p>This method can also be used to change the default compilers for standard and parallel processing, using the CXX and MPICXX flags respectively.</p>
<p>Running XMDS2 with the ‘–configure’ option also searches for packages that have been installed since you last installed or configured XMDS2.  If you wish to run ‘xmds2 –configure’ with the same extra options as last time, simply use the command:</p>
<div class="highlight-bash"><div class="highlight"><pre><span></span>$ xmds2 --reconfigure
</pre></div>
</div>
<p>A detailed log of the checks is saved in the file ‘~/.xmds/waf_configure/config.log’.  This can be used to identify issues with packages that XMDS2 is not recognised, but you think that you have successfully installed on your system.</p>
</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">
      <div><input type="text" name="q" /></div>
      <div><input type="submit" value="Go" /></div>
      <input type="hidden" name="check_keywords" value="yes" />
      <input type="hidden" name="area" value="default" />
    </form>
</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="reference_usefulXMLSyntax.html" title="Useful XML Syntax"
             >next</a> |</li>
        <li class="right" >
          <a href="reference_index.html" title="Reference section"
             >previous</a> |</li>
        <li class="nav-item nav-item-0"><a href="index.html">XMDS2 3.0.0 documentation</a> &#187;</li>
          <li class="nav-item nav-item-1"><a href="reference_index.html" >Reference section</a> &#187;</li> 
      </ul>
    </div>
    <div class="footer" role="contentinfo">
        &#169; Copyright 2008-2019, Graham Dennis, Joe Hope and Mattias Johnsson. Licensed under the GNU FDL.
      Last updated on May 17, 2019.
      Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.6.7.
    </div>
  </body>
</html>