doc/en/index.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 .. |flag| image:: ./images/drapeau_en.gif
   8
   9 Documentation of the component HOMARD |logo|
  10 --------------------------------------------
  11 The component HOMARD drives the mesh adaptation inside of the SALOME plateform.
  12
  13 User's guide
  14 """"""""""""
  15
  16 .. toctree::
  17    :maxdepth: 1
  18
  19    gui_usage
  20    tui_usage
  21    tutorials
  22
  23 General presentation
  24 """"""""""""""""""""
  25
  26 .. toctree::
  27    :maxdepth: 1
  28
  29    intro
  30    applications
  31    divers
  32
  33 Licence
  34 """""""
  35 .. index:: single: Licence
  36
  37 The licence for this module is the GNU Lesser General Public License (Lesser GPL), as stated here and in the source files.
  38
  39 .. literalinclude:: ../licence.txt
  40
  41 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:
  42
  43     * *HOMARD, a SALOME module for Mesh Adaptation*,
  44       http://www.salome-platform.org/
  45
  46     * *SALOME The Open Source Integration Platform for Numerical Simulation*,
  47       http://www.salome-platform.org/
  48
  49     * G. Nicolas and T. Fouquet, Adaptive Mesh Refinement for Conformal Hexahedral Meshes, *Finite
  50       Elements in Analysis and Design*, Vol. 67, pp. 1-12, 2013, doi:10.1016/j.finel.2012.11.008
  51
  52 The documentation of the module is also covered by the licence and the requirement of quoting.
  53
  54 Index and tables
  55 """"""""""""""""
  56
  57 * :ref:`genindex`
  58 * :ref:`modindex`
  59 * :ref:`search`
  60 * :ref:`glossaire`
  61
  62 *HOMARD is a trade mark of EDF.*
  63