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
   8 Documentation of the component HOMARD |logo|
   9 ############################################
  10 The component HOMARD drives the mesh adaptation inside of the SALOME plateform. This documentation is made of two parts. In the first part, named "User's guide", the driving of the module either with the graphical mode, or by a python script, or with a shema YACS is described. In the second part, named "General presentation", the characteristics of HOMARD are described with examples.
  11
  12 User's guide
  13 ************
  14
  15 .. toctree::
  16    :maxdepth: 1
  17
  18    demarrage_rapide
  19    gui_usage
  20    tui_usage
  21    yacs
  22    tutorials
  23
  24 General presentation
  25 ********************
  26
  27 .. toctree::
  28    :maxdepth: 1
  29
  30    intro
  31    regles
  32    divers
  33
  34 Licence
  35 *******
  36 .. index:: single: Licence
  37
  38 The licence for this module is the GNU Lesser General Public License (Lesser GPL), as stated here and in the source files.
  39
  40 .. literalinclude:: ../files/licence.en.txt
  41
  42 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:
  43
  44     * G. Nicolas, T. Fouquet, S. Geniaut, S. Cuvilliez, Improved Adaptive Mesh Refinement for Conformal Hexahedral Meshes, *Advances in Engineering Software*, Vol. 102, pp. 14-28, 2016, doi:10.1016/j.advengsoft.2016.07.014
  45
  46     * G. Nicolas and T. Fouquet, Adaptive Mesh Refinement for Conformal Hexahedral Meshes, *Finite Elements in Analysis and Design*, Vol. 67, pp. 1-12, 2013, doi:10.1016/j.finel.2012.11.008
  47
  48     * *HOMARD, a SALOME module for Mesh Adaptation*,
  49       http://www.salome-platform.org/
  50
  51     * *SALOME The Open Source Integration Platform for Numerical Simulation*,
  52       http://www.salome-platform.org/
  53
  54 The documentation of the module is also covered by the licence and the requirement of quoting.
  55
  56 Index and tables
  57 ****************
  58
  59 * :ref:`genindex`
  60 * :ref:`modindex`
  61 * :ref:`search`
  62 * :ref:`glossaire`
  63
  64 *HOMARD is a trade mark of EDF.*
  65