doc/build/html/configuration.html

   1
   2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
   3   "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   4
   5 <html xmlns="http://www.w3.org/1999/xhtml">
   6   <head>
   7     <meta http-equiv="X-UA-Compatible" content="IE=Edge" />
   8     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
   9     <title>Configuration &#8212; salomeTools 5.0.0dev documentation</title>
  10     <link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
  11     <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
  12     <script type="text/javascript" src="_static/documentation_options.js"></script>
  13     <script type="text/javascript" src="_static/jquery.js"></script>
  14     <script type="text/javascript" src="_static/underscore.js"></script>
  15     <script type="text/javascript" src="_static/doctools.js"></script>
  16     <script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
  17     <link rel="index" title="Index" href="genindex.html" />
  18     <link rel="search" title="Search" href="search.html" />
  19     <link rel="next" title="Usage of SAlomeTools" href="usage_of_sat.html" />
  20     <link rel="prev" title="Installation" href="installation_of_sat.html" />
  21
  22   <link rel="stylesheet" href="_static/custom.css" type="text/css" />
  23
  24
  25   <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
  26
  27   </head><body>
  28
  29
  30     <div class="document">
  31       <div class="documentwrapper">
  32         <div class="bodywrapper">
  33           <div class="body" role="main">
  34
  35   <div class="section" id="configuration">
  36 <h1>Configuration<a class="headerlink" href="#configuration" title="Permalink to this headline">¶</a></h1>
  37 <p><em>salomeTools</em> uses files to store its configuration parameters.</p>
  38 <p>There are several configuration files which are loaded by salomeTools in a specific order.
  39 When all the files are loaded a <em>config</em> object is created.
  40 Then, this object is passed to all command scripts.</p>
  41 <div class="section" id="syntax">
  42 <h2>Syntax<a class="headerlink" href="#syntax" title="Permalink to this headline">¶</a></h2>
  43 <p>The configuration files use a python-like structure format
  44 (see <a class="reference external" href="http://www.red-dove.com/config-doc/">config module</a> for a complete description).</p>
  45 <ul class="simple">
  46 <li><strong>{}</strong> define a dictionary,</li>
  47 <li><strong>[]</strong> define a list,</li>
  48 <li><strong>&#64;</strong> can be used to include a file,</li>
  49 <li><strong>$prefix</strong> reference to another parameter (ex: <code class="docutils literal notranslate"><span class="pre">$PRODUCT.name</span></code>),</li>
  50 <li><strong>#</strong> comments.</li>
  51 </ul>
  52 <div class="admonition note">
  53 <p class="first admonition-title">Note</p>
  54 <p class="last">in this documentation a reference to a configuration parameter will be noted <code class="docutils literal notranslate"><span class="pre">XXX.YYY</span></code>.</p>
  55 </div>
  56 </div>
  57 <div class="section" id="description">
  58 <h2>Description<a class="headerlink" href="#description" title="Permalink to this headline">¶</a></h2>
  59 <div class="section" id="vars-section">
  60 <span id="id1"></span><h3>VARS section<a class="headerlink" href="#vars-section" title="Permalink to this headline">¶</a></h3>
  61 <div class="line-block">
  62 <div class="line">This section is dynamically created by salomeTools at run time.</div>
  63 <div class="line">It contains information about the environment: date, time, OS, architecture etc.</div>
  64 </div>
  65 <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="c1"># to get the current setting</span>
  66 <span class="n">sat</span> <span class="n">config</span> <span class="o">--</span><span class="n">value</span> <span class="n">VARS</span>
  67 </pre></div>
  68 </div>
  69 </div>
  70 <div class="section" id="products-section">
  71 <h3>PRODUCTS section<a class="headerlink" href="#products-section" title="Permalink to this headline">¶</a></h3>
  72 <div class="line-block">
  73 <div class="line">This section is defined in the product file.</div>
  74 <div class="line">It contains instructions on how to build a version of SALOME (list of prerequisites-products and versions)</div>
  75 </div>
  76 <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="c1"># to get the current setting</span>
  77 <span class="n">sat</span> <span class="n">config</span> <span class="n">SALOME</span><span class="o">-</span><span class="n">xx</span> <span class="o">--</span><span class="n">value</span> <span class="n">PRODUCTS</span>
  78 </pre></div>
  79 </div>
  80 </div>
  81 <div class="section" id="application-section">
  82 <h3>APPLICATION section<a class="headerlink" href="#application-section" title="Permalink to this headline">¶</a></h3>
  83 <div class="line-block">
  84 <div class="line">This section is optional, it is also defined in the product file.</div>
  85 <div class="line">It gives additional parameters to create an application based on SALOME, as versions of products to use.</div>
  86 </div>
  87 <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="c1"># to get the current setting</span>
  88 <span class="n">sat</span> <span class="n">config</span> <span class="n">SALOME</span><span class="o">-</span><span class="n">xx</span> <span class="o">--</span><span class="n">value</span> <span class="n">APPLICATION</span>
  89 </pre></div>
  90 </div>
  91 </div>
  92 <div class="section" id="user-section">
  93 <span id="id2"></span><h3>USER section<a class="headerlink" href="#user-section" title="Permalink to this headline">¶</a></h3>
  94 <p>This section is defined by the user configuration file,
  95 <code class="docutils literal notranslate"><span class="pre">~/.salomeTools/salomeTools.pyconf</span></code>.</p>
  96 <p>The <code class="docutils literal notranslate"><span class="pre">USER</span></code> section defines some parameters (not exhaustive):</p>
  97 <ul>
  98 <li><p class="first"><strong>workDir</strong> :</p>
  99 <blockquote>
 100 <div><div class="line-block">
 101 <div class="line">The working directory.</div>
 102 <div class="line">Each product will be usually installed here (in sub-directories).</div>
 103 </div>
 104 </div></blockquote>
 105 </li>
 106 <li><p class="first"><strong>browser</strong> : The web browser to use (<em>firefox</em>).</p>
 107 </li>
 108 <li><p class="first"><strong>editor</strong> : The editor to use (<em>vi, pluma</em>).</p>
 109 </li>
 110 <li><p class="first">and other user preferences.</p>
 111 </li>
 112 </ul>
 113 <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="c1"># to get the current setting</span>
 114 <span class="n">sat</span> <span class="n">config</span> <span class="n">SALOME</span><span class="o">-</span><span class="n">xx</span> <span class="o">--</span><span class="n">value</span> <span class="n">USER</span>
 115 </pre></div>
 116 </div>
 117 </div>
 118 </div>
 119 </div>
 120
 121
 122           </div>
 123         </div>
 124       </div>
 125       <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
 126         <div class="sphinxsidebarwrapper">
 127             <p class="logo"><a href="index.html">
 128               <img class="logo" src="_static/sat_v5.0.png" alt="Logo"/>
 129             </a></p>
 130   <h3><a href="index.html">Table Of Contents</a></h3>
 131   <ul>
 132 <li><a class="reference internal" href="#">Configuration</a><ul>
 133 <li><a class="reference internal" href="#syntax">Syntax</a></li>
 134 <li><a class="reference internal" href="#description">Description</a><ul>
 135 <li><a class="reference internal" href="#vars-section">VARS section</a></li>
 136 <li><a class="reference internal" href="#products-section">PRODUCTS section</a></li>
 137 <li><a class="reference internal" href="#application-section">APPLICATION section</a></li>
 138 <li><a class="reference internal" href="#user-section">USER section</a></li>
 139 </ul>
 140 </li>
 141 </ul>
 142 </li>
 143 </ul>
 144 <div class="relations">
 145 <h3>Related Topics</h3>
 146 <ul>
 147   <li><a href="index.html">Documentation overview</a><ul>
 148       <li>Previous: <a href="installation_of_sat.html" title="previous chapter">Installation</a></li>
 149       <li>Next: <a href="usage_of_sat.html" title="next chapter">Usage of SAlomeTools</a></li>
 150   </ul></li>
 151 </ul>
 152 </div>
 153   <div role="note" aria-label="source link">
 154     <h3>This Page</h3>
 155     <ul class="this-page-menu">
 156       <li><a href="_sources/configuration.rst.txt"
 157             rel="nofollow">Show Source</a></li>
 158     </ul>
 159    </div>
 160 <div id="searchbox" style="display: none" role="search">
 161   <h3>Quick search</h3>
 162     <div class="searchformwrapper">
 163     <form class="search" action="search.html" method="get">
 164       <input type="text" name="q" />
 165       <input type="submit" value="Go" />
 166       <input type="hidden" name="check_keywords" value="yes" />
 167       <input type="hidden" name="area" value="default" />
 168     </form>
 169     </div>
 170 </div>
 171 <script type="text/javascript">$('#searchbox').show(0);</script>
 172         </div>
 173       </div>
 174       <div class="clearer"></div>
 175     </div>
 176     <div class="footer">
 177       &copy;2018, CEA.
 178
 179       |
 180       Powered by <a href="http://sphinx-doc.org/">Sphinx 1.7.3</a>
 181       &amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.10</a>
 182
 183       |
 184       <a href="_sources/configuration.rst.txt"
 185           rel="nofollow">Page source</a>
 186     </div>
 187
 188
 189
 190
 191   </body>
 192 </html>