doc/build/html/index.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>Salome Tools &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="#" />
  30     <link rel="next" title="Installation" href="installation_of_sat.html" />
  31
  32   <link rel="stylesheet" href="_static/custom.css" type="text/css" />
  33
  34
  35   <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
  36
  37   </head>
  38   <body>
  39
  40
  41     <div class="document">
  42       <div class="documentwrapper">
  43         <div class="bodywrapper">
  44           <div class="body" role="main">
  45
  46   <div class="section" id="salome-tools">
  47 <h1>Salome Tools<a class="headerlink" href="#salome-tools" title="Permalink to this headline">¶</a></h1>
  48 <a class="reference internal image-reference" href="_images/sat_about.png"><img alt="_images/sat_about.png" class="align-center" src="_images/sat_about.png" style="width: 600.0px; height: 300.0px;" /></a>
  49 <div class="admonition warning">
  50 <p class="first admonition-title">Warning</p>
  51 <p class="last">This documentation is under construction.</p>
  52 </div>
  53 <p>The <strong>Sa</strong>lome<strong>T</strong>ools (sat) is a suite of commands
  54 that can be used to perform operations on <a class="reference external" href="http://www.salome-platform.org">SALOME</a>.</p>
  55 <p>For example, sat allows you to compile SALOME's codes
  56 (prerequisites, products)
  57 create application, run tests, create package, etc.</p>
  58 <p>This utility code is a set of <a class="reference external" href="https://docs.python.org/2.7">Python</a> scripts files.</p>
  59 <div class="section" id="quick-start">
  60 <h2>Quick start<a class="headerlink" href="#quick-start" title="Permalink to this headline">¶</a></h2>
  61 <div class="toctree-wrapper compound">
  62 <ul>
  63 <li class="toctree-l1"><a class="reference internal" href="installation_of_sat.html">Installation of salomeTools</a></li>
  64 <li class="toctree-l1"><a class="reference internal" href="configuration.html">Configuration</a></li>
  65 <li class="toctree-l1"><a class="reference internal" href="usage_of_sat.html">Usage of salomeTools</a></li>
  66 </ul>
  67 </div>
  68 </div>
  69 <div class="section" id="list-of-commands">
  70 <h2>List of Commands<a class="headerlink" href="#list-of-commands" title="Permalink to this headline">¶</a></h2>
  71 <div class="toctree-wrapper compound">
  72 <ul>
  73 <li class="toctree-l1"><a class="reference internal" href="commands/config.html">config</a></li>
  74 <li class="toctree-l1"><a class="reference internal" href="commands/prepare.html">prepare</a></li>
  75 <li class="toctree-l1"><a class="reference internal" href="commands/compile.html">compile</a></li>
  76 <li class="toctree-l1"><a class="reference internal" href="commands/launcher.html">launcher</a></li>
  77 <li class="toctree-l1"><a class="reference internal" href="commands/application.html">application</a></li>
  78 <li class="toctree-l1"><a class="reference internal" href="commands/log.html">log</a></li>
  79 <li class="toctree-l1"><a class="reference internal" href="commands/environ.html">environ</a></li>
  80 <li class="toctree-l1"><a class="reference internal" href="commands/clean.html">clean</a></li>
  81 <li class="toctree-l1"><a class="reference internal" href="commands/package.html">package</a></li>
  82 <li class="toctree-l1"><a class="reference internal" href="commands/generate.html">generate</a></li>
  83 </ul>
  84 </div>
  85 </div>
  86 <div class="section" id="developer-documentation">
  87 <h2>Developer documentation<a class="headerlink" href="#developer-documentation" title="Permalink to this headline">¶</a></h2>
  88 <div class="toctree-wrapper compound">
  89 <ul>
  90 <li class="toctree-l1"><a class="reference internal" href="write_command.html">Add a command</a></li>
  91 </ul>
  92 </div>
  93 </div>
  94 <div class="section" id="code-documentation">
  95 <h2>Code documentation<a class="headerlink" href="#code-documentation" title="Permalink to this headline">¶</a></h2>
  96 <div class="toctree-wrapper compound">
  97 <ul>
  98 <li class="toctree-l1"><a class="reference internal" href="commands/apidoc/modules.html">SAT modules</a></li>
  99 </ul>
 100 </div>
 101 </div>
 102 <div class="section" id="release-notes">
 103 <h2>Release Notes<a class="headerlink" href="#release-notes" title="Permalink to this headline">¶</a></h2>
 104 <div class="toctree-wrapper compound">
 105 <ul>
 106 <li class="toctree-l1"><a class="reference internal" href="release_notes/release_notes_5.0.0.html">Release Notes 5.0.0</a></li>
 107 </ul>
 108 </div>
 109 </div>
 110 </div>
 111
 112
 113           </div>
 114         </div>
 115       </div>
 116       <div class="sphinxsidebar">
 117         <div class="sphinxsidebarwrapper">
 118             <p class="logo"><a href="#">
 119               <img class="logo" src="_static/sat_v5.0.png" alt="Logo"/>
 120             </a></p>
 121   <h3><a href="#">Table Of Contents</a></h3>
 122   <ul>
 123 <li><a class="reference internal" href="#">Salome Tools</a><ul>
 124 <li><a class="reference internal" href="#quick-start">Quick start</a><ul>
 125 </ul>
 126 </li>
 127 <li><a class="reference internal" href="#list-of-commands">List of Commands</a><ul>
 128 </ul>
 129 </li>
 130 <li><a class="reference internal" href="#developer-documentation">Developer documentation</a><ul>
 131 </ul>
 132 </li>
 133 <li><a class="reference internal" href="#code-documentation">Code documentation</a><ul>
 134 </ul>
 135 </li>
 136 <li><a class="reference internal" href="#release-notes">Release Notes</a><ul>
 137 </ul>
 138 </li>
 139 </ul>
 140 </li>
 141 </ul>
 142 <div class="relations">
 143 <h3>Related Topics</h3>
 144 <ul>
 145   <li><a href="#">Documentation overview</a><ul>
 146       <li>Next: <a href="installation_of_sat.html" title="next chapter">Installation</a></li>
 147   </ul></li>
 148 </ul>
 149 </div>
 150   <h3>This Page</h3>
 151   <ul class="this-page-menu">
 152     <li><a href="_sources/index.txt"
 153            rel="nofollow">Show Source</a></li>
 154   </ul>
 155 <div id="searchbox" style="display: none">
 156   <h3>Quick search</h3>
 157     <form class="search" action="search.html" method="get">
 158       <input type="text" name="q" />
 159       <input type="submit" value="Go" />
 160       <input type="hidden" name="check_keywords" value="yes" />
 161       <input type="hidden" name="area" value="default" />
 162     </form>
 163     <p class="searchtip" style="font-size: 90%">
 164     Enter search terms or a module, class or function name.
 165     </p>
 166 </div>
 167 <script type="text/javascript">$('#searchbox').show(0);</script>
 168         </div>
 169       </div>
 170       <div class="clearer"></div>
 171     </div>
 172     <div class="footer">
 173       &copy;2018, CEA.
 174
 175       |
 176       Powered by <a href="http://sphinx-doc.org/">Sphinx 1.1.3</a>
 177       &amp; <a href="https://github.com/bitprophet/alabaster">Alabaster </a>
 178
 179       |
 180       <a href="_sources/index.txt"
 181           rel="nofollow">Page source</a>
 182     </div>
 183
 184
 185
 186
 187   </body>
 188 </html>