.. |logo| image:: ../images/HOMARD.png
Documentation of the component HOMARD |logo|
---------------------------------------------
-The component HOMARD drives the mesh adaptation inside of the SALOME plateform.
+############################################
+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.
-*HOMARD is a trade mark of EDF.*
-
-Table of contents of this User's guide
-""""""""""""""""""""""""""""""""""""""
+User's guide
+************
.. toctree::
- :maxdepth: 2
+ :maxdepth: 1
- intro
+ demarrage_rapide
gui_usage
tui_usage
+ yacs
tutorials
+General presentation
+********************
+
+.. toctree::
+ :maxdepth: 1
+
+ intro
+ regles
+ divers
+
Licence
-"""""""
+*******
.. index:: single: Licence
The licence for this module is the GNU Lesser General Public License (Lesser GPL), as stated here and in the source files.
-.. literalinclude:: ../licence.txt
+.. literalinclude:: ../files/licence.en.txt
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:
+ * 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
+
+ * 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
+
* *HOMARD, a SALOME module for Mesh Adaptation*,
http://www.salome-platform.org/
* *SALOME The Open Source Integration Platform for Numerical Simulation*,
http://www.salome-platform.org/
- * 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
-
The documentation of the module is also covered by the licence and the requirement of quoting.
Index and tables
-""""""""""""""""
+****************
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
* :ref:`glossaire`
+*HOMARD is a trade mark of EDF.*
+
