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