doc/index_en.rst

   1 .. HOMARD documentation master file, created by
   2    sphinx-quickstart on Tue Jan  5 08:51:14 2010.
   3    You can adapt this file completely to your liking, but it should at least
   4    contain the root `toctree` directive.
   5
   6 .. |logo| image:: images/HOMARD.png
   7
   8 Documentation of the component HOMARD |logo|
   9 --------------------------------------------
  10 The component HOMARD drives the mesh adaptation inside of the SALOME plateform.
  11
  12 *HOMARD is a trade mark of EDF.*
  13
  14 Table of contents of this User's guide
  15 """"""""""""""""""""""""""""""""""""""
  16
  17 .. toctree::
  18    :maxdepth: 2
  19
  20    intro_en
  21    gui_usage_en
  22    tui_usage_en
  23    tutorials_en
  24
  25 Licence
  26 """""""
  27 .. index:: single: Licence
  28
  29 The licence for this module is the GNU Lesser General Public License (Lesser GPL), as stated here and in the source files.
  30
  31 .. literalinclude:: licence.txt
  32
  33 In addition, we expect that all publications describing work using this software, or all commercial products using it, quote at least one of the references given below:
  34
  35     * *HOMARD, a SALOME module for Mesh Adaptation*,
  36       http://www.salome-platform.org/
  37
  38     * *SALOME The Open Source Integration Platform for Numerical Simulation*,
  39       http://www.salome-platform.org/
  40
  41     * G. Nicolas and T. Fouquet, Adaptive Mesh Refinement for Conformal Hexahedral Meshes, *Finite
  42       Elements in Analysis and Design*, Vol. 67, pp. 1-12, 2013, doi:10.1016/j.finel.2012.11.008
  43
  44 The documentation of the module is also covered by the licence and the requirement of quoting.
  45
  46 Index and tables
  47 """"""""""""""""
  48
  49 * :ref:`genindex`
  50 * :ref:`modindex`
  51 * :ref:`search`
  52 * :ref:`glossaire_en`
  53