X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=doc%2Fdoxygen%2Fmain.dox;h=d4a1b6f136668240d1ce113ea88f30cce4eaacf7;hb=0511285d155a0682ff6dad10ac916ac53f577476;hp=a155d6a4d66f51c076342672ab9db7b410f7893c;hpb=48782c06022ca2caa36f849cb5a29ea4fe2aaa83;p=tools%2Fmedcoupling.git
diff --git a/doc/doxygen/main.dox b/doc/doxygen/main.dox
index a155d6a4d..d4a1b6f13 100644
--- a/doc/doxygen/main.dox
+++ b/doc/doxygen/main.dox
@@ -1,23 +1,65 @@
/*!\mainpage MEDMEM user's guide
-\image html MED_small.png
-\image latex MED_small.eps
-\anchor fig_MED_small
-
\section intro Introduction
-This document constitutes the user guide of the %MEDMEM library and of its related tools.
-
-\section install Installation
-The install procedure of the %MEDMEM library can handle a variety of configurations
-to suit the needs of its user. Instructions for configuring and installing the library can be found in \ref medmem_install.
-
-\section outline Outline
-This user guide contains three different chapters that covers the core %MEDMEM library, the %ParaMEDMEM library and the %MEDSPLITTER tool:
-- Chapter \ref medmem covers the %MEDMEM core library, i.e. the implementation of meshes, supports and fields and the associated drivers (for MED-file, VTK, GIBI).
-- Chapter \ref interpkernel describes the interpolation and
-localization library.
-- Chapter \ref paramedmem describes its MPI implementation, which is called %ParaMEDMEM.
+This document is the user guide of the %MED SALOME module. The MED
+module consists in:
+
+- \ref S1 to manipulate meshes and fields that conform
+ to the MED data model. This library can be used in C++ programs as
+ in python script for data processing on meshes and fields.
+- \ref S2 that exhibits some useful functions of the
+ library for a graphical manipulation of data in standard use cases.
+- \ref S3 that can be used to process MED data files
+
+\section S1 A library of functions for data processing
+
+The figure below represents the layer structure of the packages of the
+library:
+
+\image html medlayers_70pc.png
+
+The fondamentals consists in three atomic libraries:
+
+- \ref medcoupling that describes DataStructures used for cross process exchange of meshes and fields.
+- \ref medloader that provides I/O functions to the MED file format
+- \ref interptools (INTERP_KERNEL + REMAPPER) that provides
+ mathematical structures and algorithms for interpolation and
+ localization.
+
+You should be warned that the MEDMEM library still exists in the MED
+module but is considered as deprecated:
+
+- \ref medmem covers the %MEDMEM core library, i.e. the implementation
+ of meshes, supports and fields and the associated drivers (for
+ MED-file, VTK, GIBI).
+
+\section S2 A graphical interface for standard use cases
+
+The MED module in SALOME comes with a graphical interface that helps
+you to deal with most standard use case of fields manipulation. The
+user guide can be found here:
+
+- User guide of the MED Graphical Interface (in french)
+
+You could also be interested to read the software specifications and
+requirements for this graphical module, and even the technical
+considerations for development:
+
+- Software
+ specifications and requirements of the MED Graphical Interface (in french)
+- Developer guide of the MED Graphical Interface (in french)
+
+\section S3 A set of tools for file manipulation
+
- Chapter \ref tools describes various tools based on MEDMEM that can
-be helpful for handling MED files (conversion tools and splitting tools).
+be helpful for handling MED files (conversion tools and splitting tools).
+
+\section install Installation
+The install procedure of the %MED SALOME module can handle a variety of configurations
+to suit the needs of its user. Instructions for configuring and
+installing the module an be found in \ref medmem_install.
*/