SALOME platform
HYBRID meshing plugin
------------------------------

Contents:

1. Pre-requisites
2. Installation
3. Launch SALOME with HYBRIDPLUGIN
4. HYBRIDPLUGIN plugin usage

-----------------
1. Pre-requisites
-----------------

The information in this file assumes that:

* The SALOME platform is installed to the directory <salome>
* The HYBRID (Tepal) product is installed to the directory <salome>/hybridprl

---------------
2. Installation
---------------

2.1. Unpack HYBRIDPLUGIN module sources

cd <salome>
tar zxf HYBRIDPLUGIN_SRC.tgz

2.2. Build HYBRIDPLUGIN module

* set environment 

bash
cd <salome>
source env_build.sh

* cmake build procedure

mkdir HYBRIDPLUGIN_BUILD
cd HYBRIDPLUGIN_BUILD
cmake -DCMAKE_BUILD_TYPE=<Mode> -DCMAKE_INSTALL_PREFIX=<HYBRIDPLUGIN_INSTALL> ../HYBRIDPLUGIN_SRC

,where <Mode> is build mode (Release or Debug), 
<HYBRIDPLUGIN_INSTALL> is a destination folder to install 
HYBRIDPLUGIN module of SALOME.

Verify that all pre-requisites required for the successful compilation
of HYBRIDPLUGIN module have been found.

* compile and install plugin module 

make
make install

exit

If the compilation is finished successfully (make and make install
steps are finished without errors) the HYBRIDPLUGIN meshing module
should be installed in the directory <HYBRIDPLUGIN_INSTALL>.

----------------------------------
3. Launch SALOME with HYBRIDPLUGIN
----------------------------------

* set environment

bash
cd <salome>
source env_products.sh

export HYBRIDPLUGIN_ROOT_DIR=<HYBRIDPLUGIN_INSTALL>
export SalomeAppConfig=${HYBRIDPLUGIN_ROOT_DIR}/share/salome/resources/hybridprlplugin
export PATH=<salome>/hybridprl:${PATH

* run SALOME

runSalome

----------------------------
4. HYBRIDPLUGIN plugin usage
----------------------------

* Create new study

* Activate Geometry module and create simple geometry object

* Activate Mesh module

* Invoke menu "Mesh/Create Mesh"

* Select previously created geometry object by clicking it with the
mouse in the Object Browser

* In the "Create mesh" dialog box:
- activate "3D" page
- In the "Algorithm" combo box select "HYBRID"
- Click on the button at the right of the "Hypothesis" combo box and
select "HYBRID parameters" item in the drop-down menu

* In the "Hypothesis Construction" dialog box set parameters of HYBRID
  meshing algorithm and click "OK" button

* In the "Create mesh" dialog box Click "Apply & Close" button to
  define mesh and close the dialog box

* In the Object Browser select "Mesh_1" object, invoke context popup
menu for it by clicking right mouse button and select "Compute" item

The resulting mesh created with HYBRID plugin will be shown in the 3D
viewer.