doc/index.rst

   1 ..
   2    Copyright (C) 2012-2013 EDF
   3
   4    This file is part of SALOME HYDRO module.
   5
   6    SALOME HYDRO module is free software: you can redistribute it and/or modify
   7    it under the terms of the GNU General Public License as published by
   8    the Free Software Foundation, either version 3 of the License, or
   9    (at your option) any later version.
  10
  11    SALOME HYDRO module is distributed in the hope that it will be useful,
  12    but WITHOUT ANY WARRANTY; without even the implied warranty of
  13    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14    GNU General Public License for more details.
  15
  16    You should have received a copy of the GNU General Public License
  17    along with SALOME HYDRO module.  If not, see <http://www.gnu.org/licenses/>.
  18
  19
  20 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  21 HydroSolver module documentation
  22 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  23
  24 .. |hydrosolver_module_button| image:: /_static/HYDRO.png
  25    :align: middle
  26    :width: 16pt
  27    :height: 16pt
  28
  29 This documentation covers the usage of HydroSolver module in Salome. This module
  30 aims at providing services for the usage of Telemac and Mascaret codes. To
  31 activate this module, click on the |hydrosolver_module_button| button in the
  32 toolbar or select "HydroSolver" item in the "SALOME" menu. The first part of
  33 this guide addresses simple use cases (how to run the codes from Salome-Hydro
  34 platform) while the second part presents more advanced topics (code coupling).
  35
  36 .. toctree::
  37    :maxdepth: 2
  38
  39    basic.rst
  40    advanced.rst