README

   1 This is the Med Memory package V3.2.0
   2
   3 I : Major evolution of the Med Memory package between V2.2.x and V3.2.x :
   4 =========================================================================
   5
   6 The Med Memory may be used as a stand alone package with only the C++ and the
   7 python layers (adding --without-kernel at the configure step). In this case
   8 there are no links with the SALOME KERNEL.
   9
  10 In this version,
  11
  12 - mesh defined with polygones/polyhedra mixed with usual types of cells;
  13
  14 - the Med File drivers of the Med Memory support the V2.1 as well as the
  15   V2.2 versions of the Med File layer. The requirement of the Salome platform
  16   is only Med File V2.2, the V2.1 version is emberked in the Med Memory.
  17
  18 - Using the Med file (V2.1 and V2.2) and GIBI drivers; fields laying on a
  19   partial support;
  20
  21 - Fields defined on cells mesh with multiple gauss points,
  22
  23 may be mounted in memory and treated.
  24
  25 With all those new functionalities, most of the Med Memory client codes
  26 based on previous releases of the Med Memory should work; but minor changes
  27 should be done for the get/set field classes methods:
  28
  29 - the getValue() and the setValue(T *) methods take no MED_EN::medModeSwitch
  30   parameter;
  31 - the getValueI (resp. setValueI) should be replaced by getRow(int )
  32   (resp. setRow(int ,T*) if the field is in full interlacing mode (using the
  33   method getInterlacingType() of the classe FIELD_). If the field is stored in
  34   no interlacing mode getValueIJ (resp. setValueIJ) should be replaced by
  35   getColumn(int ) (resp. setColumn(int ,T*)).
  36
  37 Intensive debugging was carried throughout the entire Med Memory C++ Layer:
  38
  39   - especially on the major user's C++ classes (such as MED, MESH,
  40     SUPPORT and FIELD);
  41
  42   - the C++ drivers classes on those major classes. Especially the
  43     Med File and the GIBI drivers are read/write ones. The VTK drivers
  44     are only for the writing; and finally the PORFLOW drivers may only
  45     be used for the MESH class in the reading mode.
  46
  47 The Med Client layer of the Med Memory has been tested in a full
  48 Server/Client configuration.
  49
  50 II : MedMemory building and installation :
  51 =========================================
  52
  53 Assuming that the rather straightforward
  54
  55 path_to_your_MedMemory_installation_directory,
  56
  57 path_to_your_MedMemory_building_directory,
  58
  59 path_to_your_MedMemory_sources_directory,
  60
  61 path_to_your_MedFile_installation_directory,
  62
  63 path_to_your_HDF5_installation_directory,
  64
  65 directories are setted; the user/installer may use the following commands to
  66 build the Med Memory installation as a Salome component :
  67
  68 In the directory path_to_your_MedMemory_building_directory;
  69
  70 path_to_your_MedMemory_sources_directory/build_configure
  71
  72 path_to_your_MedMemory_sources_directory/configure --prefix=path_to_your_MedMemory_installation_directory
  73
  74 make
  75
  76 make install
  77
  78 Eventually if the user/installer needs to build an installation of Med
  79 Memory as a stand alone package, he/she may use always in the
  80 path_to_your_MedMemory_building_directory, the following commands :
  81
  82 path_to_your_MedMemory_sources_directory/build_configure --without-kernel
  83
  84 path_to_your_MedMemory_sources_directory/configure --prefix=path_to_your_MedMemory_installation_directory
  85
  86 make
  87
  88 make install
  89
  90 Remark :  If the installer gets the sources archives from the NEPAL web site
  91 --------  (CEA, EDF, OCC, ie hammi web site) the user may only use the
  92           following commands :
  93
  94           path_to_your_MedMemory_sources_directory/configure --prefix=path_to_your_MedMemory_installation_directory
  95
  96           make
  97
  98           make install
  99
 100
 101 By default the full debug options are set:
 102       - compilation using -g option
 103       - Med Memory debugging information history using -D_DEBUG_ option.
 104
 105 The user/installer may
 106
 107 get all configure option with :
 108
 109 path_to_your_MedMemory_sources_directory/configure --help
 110
 111 set optimization option :
 112
 113 path_to_your_MedMemory_sources_directory/configure --enable-production --disable-debug (use compiler flags -O)
 114
 115 In order to avoid most of the problem the user/installer should first
 116 check the $HDF5HOME and the $MED2HOME environment variables. In csh:
 117
 118 setenv HDF5HOME path_to_your_HDF5_installation_directory
 119
 120 setenv MED2HOME path_to_your_MedFile_installation_directory
 121
 122 This version of Med Memory has been tested with Med File V2.2.2, V2.2.3, as
 123 well as V2.3.0 but with the version of HDF5 V1.6.3. Thus, in the installation
 124 process of Med File the user/installer should take care of the $HDF5HOME
 125 environement variable. This warning is especially intended to the user of the
 126 Med Memory in its stand alone vesion (ie without the SALOME KERNEL component).
 127
 128 III : MedMemory testing :
 129 =========================
 130
 131 After installation of the Med Memory; the user/installer may find a large set
 132 of Med File V2.1, V2.2, GIBI test files in the directory :
 133
 134 path_to_your_MedMemory_installation_directory/share/salome/resources/
 135
 136 For user/installer of the Med Meory as a Salome component, sourcing the usual
 137 Salome environement and using the usual runSalome command, all needed
 138 environement variables (such as $MED_ROOT_DIR, $LD_LIBRARY_PATH and
 139 $PYTHONPATH) are well setted.
 140
 141 But for the user/installer of the Med Memory as a stand alone version should
 142 set his/her environement. Assuming that $HDF5HOME $MED2HOME are setted
 143 properly, in csh :
 144
 145 setenv MED_ROOT_DIR path_to_your_MedMemory_installation_directory
 146
 147 setenv PATH ${MED2HOME}/bin:${HDF5HOME}/bin:$PATH
 148
 149 setenv LD_LIBRARY_PATH ${MED_ROOT_DIR}/lib/salome:${MED2HOME}/lib:${HDF5HOME}/lib:$LD_LIBRARY_PATH
 150
 151 setenv PYTHONPATH ${MED_ROOT_DIR}/bin/salome:${MED_ROOT_DIR}/lib/salome:${MED_ROOT_DIR}/lib/python${PYTHON_VERSION}/site-packages/salome:
 152
 153 To check the Med Memory installation, in the directory
 154 path_to_your_MedMemory_installation_directory/bin/salome you may find a set of
 155 python scripts and test executable. To ckeck the deep layers (C++, Python) of
 156 the Med Memory, the installer may run:
 157
 158 - testMedMemGeneral.py,
 159 - medMeshing_test.py
 160 - test_profil_MedFieldDriver.py
 161 - testGaussLocalization.py
 162 - med_field_anal.py
 163 - test_MEDMEM_MeshingFlica
 164 - test_MEDMEM_Meshing_poly
 165 - test_MEDMEM_MeshingPoly
 166
 167 To check the upper layer (CORBA, Client), the installer may run in the SALOME
 168 Python consol:
 169
 170  - Med_Gen_test.py
 171  - medClient_test.py
 172  - testMedAlliances1.py
 173  - testMedAlliances.py
 174  - testMeshAlliances.py