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