Salome HOME
ea2d33085145f823a68a30cd2311e5c43fb790a6
[modules/homard.git] / 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.
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:: ../licence.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     * *HOMARD, a SALOME module for Mesh Adaptation*,
45       http://www.salome-platform.org/
46
47     * *SALOME The Open Source Integration Platform for Numerical Simulation*,
48       http://www.salome-platform.org/
49
50     * G. Nicolas and T. Fouquet, Adaptive Mesh Refinement for Conformal Hexahedral Meshes, *Finite
51       Elements in Analysis and Design*, Vol. 67, pp. 1-12, 2013, doi:10.1016/j.finel.2012.11.008
52
53 The documentation of the module is also covered by the licence and the requirement of quoting.
54
55 Index and tables
56 ****************
57
58 * :ref:`genindex`
59 * :ref:`modindex`
60 * :ref:`search`
61 * :ref:`glossaire`
62
63 *HOMARD is a trade mark of EDF.*
64