-# Copyright (C) 2007-2015 CEA/DEN, EDF R&D
+# Copyright (C) 2007-2016 CEA/DEN, EDF R&D
#
# This library is free software; you can redistribute it and/or
# modify it under the terms of the GNU Lesser General Public
-# Copyright (C) 2012-2015 CEA/DEN, EDF R&D, OPEN CASCADE
+# Copyright (C) 2012-2016 CEA/DEN, EDF R&D
#
# This library is free software; you can redistribute it and/or
# modify it under the terms of the GNU Lesser General Public
-# Copyright (C) 2007-2015 CEA/DEN, EDF R&D
+# Copyright (C) 2007-2016 CEA/DEN, EDF R&D
#
# This library is free software; you can redistribute it and/or
# modify it under the terms of the GNU Lesser General Public
-// Copyright (C) 2007-2015 CEA/DEN, EDF R&D
+// Copyright (C) 2007-2016 CEA/DEN, EDF R&D
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
+++ /dev/null
-# Copyright (C) 2007-2015 CEA/DEN, EDF R&D
-#
-# This library is free software; you can redistribute it and/or
-# modify it under the terms of the GNU Lesser General Public
-# License as published by the Free Software Foundation; either
-# version 2.1 of the License, or (at your option) any later version.
-#
-# This library is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
-# Lesser General Public License for more details.
-#
-# You should have received a copy of the GNU Lesser General Public
-# License along with this library; if not, write to the Free Software
-# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
-#
-# See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
-#
-
-# ---
-#
-# File : INSTALL
-# Author : Vadim SANDLER, Open CASCADE S.A.S (vadim.sandler@opencascade.com)
-#
-# ---
-
-SALOME2 : HYBRIDPLUGIN module (SMESH plugin)
-
-For installation instructions and other information, please refer to
-the README file.
+++ /dev/null
-# Copyright (C) 2007-2015 CEA/DEN, EDF R&D
-#
-# This library is free software; you can redistribute it and/or
-# modify it under the terms of the GNU Lesser General Public
-# License as published by the Free Software Foundation; either
-# version 2.1 of the License, or (at your option) any later version.
-#
-# This library is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
-# Lesser General Public License for more details.
-#
-# You should have received a copy of the GNU Lesser General Public
-# License along with this library; if not, write to the Free Software
-# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
-#
-# See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
-#
-
-# ---
-#
-# File : NEWS
-# Author : Vadim SANDLER, Open CASCADE S.A.S (vadim.sandler@opencascade.com)
-#
-# ---
-#
-# Changes are listed by modification time in the descending order,
-# i.e. newer changes are listed at the top of the file.
-#
-# ---
-SALOME platform
-HYBRID meshing plugin
-------------------------------
+***************************
+About SALOME Hybrid plug-in
+***************************
-Contents:
+SALOME Hybrid plug-in adds DISTENE MG-Hybrid meshing algorithm to the
+SALOME Mesh module.
-1. Pre-requisites
-2. Installation
-3. Launch SALOME with HYBRIDPLUGIN
-4. HYBRIDPLUGIN plugin usage
+Hybrid plugin is designed for:
+- Meshing of 3D geometric closed entities: volumes are split into tetrahedra,
+ pyramids, prisms and hexahedra elements.
+- Generating of 3D meshes from 2D meshes of a wrap (triangles and quadrangles),
+ working with geometrical objects for setting and meshing layers.
------------------
-1. Pre-requisites
------------------
+For more information please visit the SALOME platform web site:
-The information in this file assumes that:
+ <http://www.salome-platform.org/>
-* The SALOME platform is installed to the directory <salome>
-* The HYBRID (Tepal) product is installed to the directory <salome>/hybridprl
+=======
+License
+=======
----------------
-2. Installation
----------------
+SALOME platform is distributed under the GNU Lesser General Public License.
+See COPYING file for more details.
-2.1. Unpack HYBRIDPLUGIN module sources
+Also, additional information can be found at SALOME platform web site:
-cd <salome>
-tar zxf HYBRIDPLUGIN_SRC.tgz
+ <http://www.salome-platform.org/downloads/license/>
-2.2. Build HYBRIDPLUGIN module
+============
+Installation
+============
-* set environment
+--------------
+Pre-requisites
+--------------
-bash
-cd <salome>
-source env_build.sh
+SALOME platform relies on a set of third-party softwares; some of them are needed
+at build time only, while other ones are needed in runtime also.
-* cmake build procedure
+For more information about the pre-requisites please visit SALOME platform web
+site:
-mkdir HYBRIDPLUGIN_BUILD
-cd HYBRIDPLUGIN_BUILD
-cmake -DCMAKE_BUILD_TYPE=<Mode> -DCMAKE_INSTALL_PREFIX=<HYBRIDPLUGIN_INSTALL> ../HYBRIDPLUGIN_SRC
+* Check Release Notes and Software Requirements of the latest SALOME release at
-,where <Mode> is build mode (Release or Debug),
-<HYBRIDPLUGIN_INSTALL> is a destination folder to install
-HYBRIDPLUGIN module of SALOME.
+ <http://www.salome-platform.org/downloads/current-version/>
-Verify that all pre-requisites required for the successful compilation
-of HYBRIDPLUGIN module have been found.
+* Pre-requisites page at SALOME web site:
-* compile and install plugin module
+ <http://www.salome-platform.org/downloads/license/>
-make
-make install
+Note: SALOME Hybrid plug-in needs SALOME KERNEL, SALOME GUI,
+SALOME Geometry and SALOME Mesh as pre-requisites.
-exit
+------------------
+Basic Installation
+------------------
-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>.
+The build procedure of the SALOME platform is implemented with CMake.
+In order to build the plug-in you have to do the following actions:
-----------------------------------
-3. Launch SALOME with HYBRIDPLUGIN
-----------------------------------
+1. Set up environment for pre-requisites (see "Pre-requisites" section above).
-* set environment
+2. Create a build directory:
-bash
-cd <salome>
-source env_products.sh
+ % mkdir HYBRIDPLUGIN_BUILD
-export HYBRIDPLUGIN_ROOT_DIR=<HYBRIDPLUGIN_INSTALL>
-export SalomeAppConfig=${HYBRIDPLUGIN_ROOT_DIR}/share/salome/resources/hybridprlplugin
-export PATH=<salome>/hybridprl:${PATH
+3. Configure the build procedure:
-* run SALOME
+ % cd HYBRIDPLUGIN_BUILD
+ % cmake -DCMAKE_BUILD_TYPE=<mode> -DCMAKE_INSTALL_PREFIX=<installation_directory> <path_to_src_dir>
-runSalome
+ where
+ - <mode> is either Release or Debug (default: Release);
+ - <installation_directory> is a destination folder to install SALOME Hybrid
+ plug-in (default: /usr);
+ - <path_to_src_dir> is a path to the SALOME Hybrid plug-in sources
+ directory.
-----------------------------
-4. HYBRIDPLUGIN plugin usage
-----------------------------
+ Note: by default (if CMAKE_INSTALL_PREFIX option is not given), SALOME Hybrid
+ plug-in will be configured for installation to the /usr directory that
+ requires root permissions to complete the installation.
-* Create new study
+4. Build and install:
-* Activate Geometry module and create simple geometry object
+ % make
+ % make install
-* Activate Mesh module
+ This will install SALOME Hybrid plug-in to the <installation_directory>
+ specified to cmake command on the previous step.
-* Invoke menu "Mesh/Create Mesh"
+-------------------
+Custom installation
+-------------------
+
+SALOME Hybrid plug-in supports a set of advanced configuration options;
+for more details learn CMakeLists.txt file in the root source directory.
+
+You can also use other options of cmake command to customize your installation.
+Learn more about available options by typing
+
+ % cmake --help
+
+=====
+Usage
+=====
+
+* Start SALOME.
+
+* 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
+ 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
+ - Activate "3D" page;
+ - In the "Algorithm" combo box select "Tetrahedron etc... (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 "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
+ 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
+ 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
+The resulting mesh created with Hybrid plugin will be shown in the 3D
viewer.
+
+=============
+Documentation
+=============
+
+The directory doc contains additional documentation file of SALOME Hybrid
+plug-in.
+
+===============
+Troubleshooting
+===============
+
+Please, send a mail to webmaster.salome@opencascade.com.
-# Copyright (C) 2013-2015 CEA/DEN, EDF R&D
+# Copyright (C) 2013-2016 CEA/DEN, EDF R&D
#
# This library is free software; you can redistribute it and/or
# modify it under the terms of the GNU Lesser General Public
-# Copyright (C) 2007-2015 CEA/DEN, EDF R&D, OPEN CASCADE
+# Copyright (C) 2007-2016 CEA/DEN, EDF R&D
#
# This library is free software; you can redistribute it and/or
# modify it under the terms of the GNU Lesser General Public
-# Copyright (C) 2012-2015 CEA/DEN, EDF R&D, OPEN CASCADE
+# Copyright (C) 2012-2016 CEA/DEN, EDF R&D
#
# This library is free software; you can redistribute it and/or
# modify it under the terms of the GNU Lesser General Public
-# Copyright (C) 2007-2015 CEA/DEN, EDF R&D
+# Copyright (C) 2007-2016 CEA/DEN, EDF R&D
#
# This library is free software; you can redistribute it and/or
# modify it under the terms of the GNU Lesser General Public
-# Copyright (C) 2007-2015 CEA/DEN, EDF R&D
+# Copyright (C) 2007-2016 CEA/DEN, EDF R&D
#
# This library is free software; you can redistribute it and/or
# modify it under the terms of the GNU Lesser General Public
-# Copyright (C) 2012-2015 CEA/DEN, EDF R&D, OPEN CASCADE
+# Copyright (C) 2012-2016 CEA/DEN, EDF R&D
#
# This library is free software; you can redistribute it and/or
# modify it under the terms of the GNU Lesser General Public
-# Copyright (C) 2007-2015 CEA/DEN, EDF R&D, OPEN CASCADE
+# Copyright (C) 2007-2016 CEA/DEN, EDF R&D
#
# This library is free software; you can redistribute it and/or
# modify it under the terms of the GNU Lesser General Public
-# Copyright (C) 2007-2015 CEA/DEN, EDF R&D
+# Copyright (C) 2007-2016 CEA/DEN, EDF R&D
#
# This library is free software; you can redistribute it and/or
# modify it under the terms of the GNU Lesser General Public
-# Copyright (C) 2007-2015 CEA/DEN, EDF R&D
+# Copyright (C) 2007-2016 CEA/DEN, EDF R&D
#
# This library is free software; you can redistribute it and/or
# modify it under the terms of the GNU Lesser General Public
-dnl Copyright (C) 2004-2015 CEA/DEN, EDF R&D
+dnl Copyright (C) 2004-2016 CEA/DEN, EDF R&D
dnl
dnl This library is free software; you can redistribute it and/or
dnl modify it under the terms of the GNU Lesser General Public
-# Copyright (C) 2012-2015 CEA/DEN, EDF R&D, OPEN CASCADE
+# Copyright (C) 2012-2016 CEA/DEN, EDF R&D
#
# This library is free software; you can redistribute it and/or
# modify it under the terms of the GNU Lesser General Public
-# Copyright (C) 2007-2015 CEA/DEN, EDF R&D, OPEN CASCADE
+# Copyright (C) 2007-2016 CEA/DEN, EDF R&D, OPEN CASCADE
#
# This library is free software; you can redistribute it and/or
# modify it under the terms of the GNU Lesser General Public
-# Copyright (C) 2007-2015 CEA/DEN, EDF R&D, OPEN CASCADE
+# Copyright (C) 2007-2016 CEA/DEN, EDF R&D, OPEN CASCADE
#
# This library is free software; you can redistribute it and/or
# modify it under the terms of the GNU Lesser General Public
-# Copyright (C) 2013-2015 CEA/DEN, EDF R&D, OPEN CASCADE
+# Copyright (C) 2013-2016 CEA/DEN, EDF R&D, OPEN CASCADE
#
# This library is free software; you can redistribute it and/or
# modify it under the terms of the GNU Lesser General Public
-# Copyright (C) 2007-2015 CEA/DEN, EDF R&D, OPEN CASCADE
+# Copyright (C) 2007-2016 CEA/DEN, EDF R&D, OPEN CASCADE
#
# This library is free software; you can redistribute it and/or
# modify it under the terms of the GNU Lesser General Public
-# Copyright (C) 2012-2015 CEA/DEN, EDF R&D, OPEN CASCADE
+# Copyright (C) 2012-2016 CEA/DEN, EDF R&D, OPEN CASCADE
#
# This library is free software; you can redistribute it and/or
# modify it under the terms of the GNU Lesser General Public
-# Copyright (C) 2007-2015 CEA/DEN, EDF R&D, OPEN CASCADE
+# Copyright (C) 2007-2016 CEA/DEN, EDF R&D, OPEN CASCADE
#
# This library is free software; you can redistribute it and/or
# modify it under the terms of the GNU Lesser General Public
-# Copyright (C) 2007-2015 CEA/DEN, EDF R&D, OPEN CASCADE
+# Copyright (C) 2007-2016 CEA/DEN, EDF R&D, OPEN CASCADE
#
# This library is free software; you can redistribute it and/or
# modify it under the terms of the GNU Lesser General Public
<ul>
$navpath
<li class="footer">
- Copyright © 2007-2015 CEA/DEN, EDF R&D<br>
+ Copyright © 2007-2016 CEA/DEN, EDF R&D<br>
</li>
</ul>
</div>
-# Copyright (C) 2012-2015 CEA/DEN, EDF R&D, OPEN CASCADE
+# Copyright (C) 2012-2016 CEA/DEN, EDF R&D
#
# This library is free software; you can redistribute it and/or
# modify it under the terms of the GNU Lesser General Public
-// Copyright (C) 2007-2015 CEA/DEN, EDF R&D
+// Copyright (C) 2007-2016 CEA/DEN, EDF R&D
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
-# Copyright (C) 2007-2015 CEA/DEN, EDF R&D, OPEN CASCADE
+# Copyright (C) 2007-2016 CEA/DEN, EDF R&D
#
# This library is free software; you can redistribute it and/or
# modify it under the terms of the GNU Lesser General Public
<?xml version='1.0' encoding='us-ascii'?>
<!DOCTYPE meshers PUBLIC "" "desktop.dtd">
<!--
- Copyright (C) 2004-2015 CEA/DEN, EDF R&D
+ Copyright (C) 2004-2016 CEA/DEN, EDF R&D
This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Lesser General Public
<!--
- Copyright (C) 2004-2015 CEA/DEN, EDF R&D
+ Copyright (C) 2004-2016 CEA/DEN, EDF R&D
This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Lesser General Public
-# Copyright (C) 2012-2015 CEA/DEN, EDF R&D, OPEN CASCADE
+# Copyright (C) 2012-2016 CEA/DEN, EDF R&D
#
# This library is free software; you can redistribute it and/or
# modify it under the terms of the GNU Lesser General Public
-# Copyright (C) 2012-2015 CEA/DEN, EDF R&D, OPEN CASCADE
+# Copyright (C) 2012-2016 CEA/DEN, EDF R&D
#
# This library is free software; you can redistribute it and/or
# modify it under the terms of the GNU Lesser General Public
-// Copyright (C) 2007-2015 CEA/DEN, EDF R&D
+// Copyright (C) 2007-2016 CEA/DEN, EDF R&D
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
-// Copyright (C) 2007-2015 CEA/DEN, EDF R&D
+// Copyright (C) 2007-2016 CEA/DEN, EDF R&D
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
-// Copyright (C) 2007-2015 CEA/DEN, EDF R&D
+// Copyright (C) 2007-2016 CEA/DEN, EDF R&D
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
-// Copyright (C) 2007-2015 CEA/DEN, EDF R&D
+// Copyright (C) 2007-2016 CEA/DEN, EDF R&D
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
-// Copyright (C) 2007-2015 CEA/DEN, EDF R&D
+// Copyright (C) 2007-2016 CEA/DEN, EDF R&D
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
-// Copyright (C) 2007-2015 CEA/DEN, EDF R&D
+// Copyright (C) 2007-2016 CEA/DEN, EDF R&D
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
-# Copyright (C) 2012-2015 CEA/DEN, EDF R&D, OPEN CASCADE
+# Copyright (C) 2012-2016 CEA/DEN, EDF R&D
#
# This library is free software; you can redistribute it and/or
# modify it under the terms of the GNU Lesser General Public
# -*- coding: utf-8 -*-
-# Copyright (C) 2007-2015 CEA/DEN, EDF R&D
+# Copyright (C) 2007-2016 CEA/DEN, EDF R&D
#
# This library is free software; you can redistribute it and/or
# modify it under the terms of the GNU Lesser General Public
-// Copyright (C) 2004-2015 CEA/DEN, EDF R&D
+// Copyright (C) 2004-2016 CEA/DEN, EDF R&D
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
-// Copyright (C) 2007-2015 CEA/DEN, EDF R&D
+// Copyright (C) 2007-2016 CEA/DEN, EDF R&D
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
-// Copyright (C) 2007-2015 CEA/DEN, EDF R&D
+// Copyright (C) 2007-2016 CEA/DEN, EDF R&D
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
-// Copyright (C) 2007-2015 CEA/DEN, EDF R&D
+// Copyright (C) 2007-2016 CEA/DEN, EDF R&D
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
-// Copyright (C) 2007-2015 CEA/DEN, EDF R&D
+// Copyright (C) 2007-2016 CEA/DEN, EDF R&D
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
-// Copyright (C) 2007-2015 CEA/DEN, EDF R&D
+// Copyright (C) 2007-2016 CEA/DEN, EDF R&D
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
-// Copyright (C) 2007-2015 CEA/DEN, EDF R&D
+// Copyright (C) 2007-2016 CEA/DEN, EDF R&D
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
-// Copyright (C) 2007-2015 CEA/DEN, EDF R&D
+// Copyright (C) 2007-2016 CEA/DEN, EDF R&D
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
-// Copyright (C) 2007-2015 CEA/DEN, EDF R&D
+// Copyright (C) 2007-2016 CEA/DEN, EDF R&D
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
-// Copyright (C) 2007-2015 CEA/DEN, EDF R&D
+// Copyright (C) 2007-2016 CEA/DEN, EDF R&D
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
-# Copyright (C) 2007-2015 CEA/DEN, EDF R&D
+# Copyright (C) 2007-2016 CEA/DEN, EDF R&D
#
# This library is free software; you can redistribute it and/or
# modify it under the terms of the GNU Lesser General Public