Salome HOME
[CEA 13302] Policy for c++ files ? using namespaces in c++ header files. boost_ptr...
[modules/med.git] / README
diff --git a/README b/README
index 1e366e41bb60ccf1a3317349d8281855e7e038ad..b61c1cfbf17a751e856b4152760dbdb799343e04 100644 (file)
--- a/README
+++ b/README
@@ -1,4 +1,5 @@
-This is the Med Memory package V3.2.0
+Documentation for the MEDMEM library and related tools is given in
+$(prefix)/doc/user/html/index.html
 
 I : Major evolution of the Med Memory package between V2.2.x and V3.2.x :
 =========================================================================
@@ -30,7 +31,7 @@ should be done for the get/set field classes methods:
   parameter;
 - the getValueI (resp. setValueI) should be replaced by getRow(int )
   (resp. setRow(int ,T*) if the field is in full interlacing mode (using the
-  method getInterlacingType() of the classe FIELD_). If the field is stored in
+  method getInterlacingType() of the class FIELD_). If the field is stored in
   no interlacing mode getValueIJ (resp. setValueIJ) should be replaced by
   getColumn(int ) (resp. setColumn(int ,T*)).
 
@@ -50,110 +51,42 @@ Server/Client configuration.
 II : MedMemory building and installation :
 =========================================
 
-Assuming that the rather straightforward
-
-path_to_your_MedMemory_installation_directory,
-
-path_to_your_MedMemory_building_directory,
-
-path_to_your_MedMemory_sources_directory,
-
-path_to_your_MedFile_installation_directory,
-
-path_to_your_HDF5_installation_directory,
-
-directories are setted; the user/installer may use the following commands to
-build the Med Memory installation as a Salome component :
-
-In the directory path_to_your_MedMemory_building_directory;
-
-path_to_your_MedMemory_sources_directory/build_configure
-
-path_to_your_MedMemory_sources_directory/configure --prefix=path_to_your_MedMemory_installation_directory
+It's very simple :
 
+./configure --prefix=path_to_your_installation_directory
 make
-
 make install
 
-Eventually if the user/installer needs to build an installation of Med
-Memory as a stand alone package, he/she may use always in the
-path_to_your_MedMemory_building_directory, the following commands :
-
-path_to_your_MedMemory_sources_directory/build_configure --without-kernel
-
-path_to_your_MedMemory_sources_directory/configure --prefix=path_to_your_MedMemory_installation_directory
-
-make
-
-make install
-
-Remark :  If the installer gets the sources archives from the NEPAL web site
---------  (CEA, EDF, OCC, ie hammi web site) the user may only use the
-          following commands :
-
-          path_to_your_MedMemory_sources_directory/configure --prefix=path_to_your_MedMemory_installation_directory
-
-          make
-
-          make install
-
-
-By default the full debug options are set:
+eventually if the user or the installer needs to build an installation of Med
+Memory as a stand alone package, he may use the configure option
+--without-kernel. By default the full debug options are set:
       - compilation using -g option
       - Med Memory debugging information history using -D_DEBUG_ option.
 
-The user/installer may
-
-get all configure option with :
-
-path_to_your_MedMemory_sources_directory/configure --help
-
-set optimization option :
-
-path_to_your_MedMemory_sources_directory/configure --enable-production --disable-debug (use compiler flags -O)
-
-In order to avoid most of the problem the user/installer should first
-check the $HDF5HOME and the $MED2HOME environment variables. In csh:
+The user may get all configure option with :
+  ./configure --help
 
-setenv HDF5HOME path_to_your_HDF5_installation_directory
+The user may set optimization option :
+  ./configure --enable-production --disable-debug (use compiler flags -O)
 
-setenv MED2HOME path_to_your_MedFile_installation_directory
-
-This version of Med Memory has been tested with Med File V2.2.2, V2.2.3, as
-well as V2.3.0 but with the version of HDF5 V1.6.3. Thus, in the installation
-process of Med File the user/installer should take care of the $HDF5HOME
-environement variable. This warning is especially intended to the user of the
-Med Memory in its stand alone vesion (ie without the SALOME KERNEL component).
+In order to avoid most of the problem the user or the installer should first
+check the HDF5HOME and the MED2HOME environment variables. This version of
+Med Memory with Med File V2.2.2, V2.2.3, as well as V2.3.0 but with the
+version of HDF5 V1.6.3. In the installation of Med File you should take care
+of the $HDF5HOME environment variable. This warning is especially intended
+to the user of The Med Memory in stand alone (without the SALOME KERNEL
+component).
 
 III : MedMemory testing :
 =========================
 
-After installation of the Med Memory; the user/installer may find a large set
-of Med File V2.1, V2.2, GIBI test files in the directory :
-
-path_to_your_MedMemory_installation_directory/share/salome/resources/
-
-For user/installer of the Med Meory as a Salome component, sourcing the usual
-Salome environement and using the usual runSalome command, all needed
-environement variables (such as $MED_ROOT_DIR, $LD_LIBRARY_PATH and
-$PYTHONPATH) are well setted.
-
-But for the user/installer of the Med Memory as a stand alone version should
-set his/her environement. Assuming that $HDF5HOME $MED2HOME are setted
-properly, in csh :
-
-setenv MED_ROOT_DIR path_to_your_MedMemory_installation_directory
-
-setenv PATH ${MED2HOME}/bin:${HDF5HOME}/bin:$PATH
-
-setenv LD_LIBRARY_PATH ${MED_ROOT_DIR}/lib/salome:${MED2HOME}/lib:${HDF5HOME}/lib:$LD_LIBRARY_PATH
-
-setenv PYTHONPATH ${MED_ROOT_DIR}/bin/salome:${MED_ROOT_DIR}/lib/salome:${MED_ROOT_DIR}/lib/python${PYTHON_VERSION}/site-packages/salome:
+After installation of the Med Memory; the user may find a large set of test
+files in Med File V2.1, V2.2, GIBI format.
 
 To check the Med Memory installation, in the directory
-path_to_your_MedMemory_installation_directory/bin/salome you may find a set of
-python scripts and test executable. To ckeck the deep layers (C++, Python) of
-the Med Memory, the installer may run:
+path_to_your_installation_directory/bin/salome you may find a set of python
+scripts and test executable. To ckeck the deep layers (C++, Python) of the Med
+Memory, the installer may run:
 
 - testMedMemGeneral.py,
 - medMeshing_test.py
@@ -165,7 +98,7 @@ the Med Memory, the installer may run:
 - test_MEDMEM_MeshingPoly
 
 To check the upper layer (CORBA, Client), the installer may run in the SALOME
-Python consol:
+Python console:
 
  - Med_Gen_test.py
  - medClient_test.py