-SALOME platform
-BLSURF meshing plugin
-------------------------------
+*******************************
+About SALOME MG-CADSurf plug-in
+*******************************
-Contents:
+SALOME MG-CADSurf plug-in adds DISTENE MG-CADSurf (former BLSURF) meshing algorithm
+to the SALOME Mesh module.
-1. Pre-requisites
-2. Installation
-3. Launch SALOME with BLSURFPLUGIN
-4. BLSURFPLUGIN plugin usage
+MG-CADSurf meshing algorithm is destined for generation of 2D meshes basing
+on the 2D geometric entities (faces).
------------------
-1. Pre-requisites
------------------
+For more information please visit the SALOME platform web site:
-The information in this file assumes that:
+ <https://www.salome-platform.org/>
-* The SALOME platform is installed to the directory <salome>
-* The blsurf product is installed to the directory <salome>/blsurf
-* The decimesh binary is vaiable via environment variable PATH
+=======
+License
+=======
----------------
-2. Installation
----------------
+SALOME platform is distributed under the GNU Lesser General Public License.
+See COPYING file for more details.
-2.1. Unpack BLSURFPLUGIN module sources
+============
+Installation
+============
-cd <salome>
-tar zxf BLSURFPLUGIN_SRC.tgz
+--------------
+Pre-requisites
+--------------
-2.2. Build BLSURFPLUGIN module
+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.
-* set environment
+For more information about the pre-requisites please visit SALOME platform web
+site:
-bash
-cd <salome>
-source env_build.sh
-export BLSURFHOME=<salome>/blsurf
+* Check Release Notes and Software Requirements of the latest SALOME release at
-Note: you can avoid setting BLSURFHOME environment variable but use
---with-blsurf key of configure script instead.
+ <https://www.salome-platform.org/?page_id=15/>
-* configure build system
+Note: SALOME MG-CADSurf plug-in needs SALOME KERNEL, SALOME GUI, SALOME Geometry
+and SALOME Mesh as pre-requisites.
-cd BLSURFPLUGIN_SRC
-./build_configure
+------------------
+Basic Installation
+------------------
-cd ..
-mkdir BLSURFPLUGIN_BUILD
-cd BLSURFPLUGIN_BUILD
-../BLSURFPLUGIN_SRC/configure --prefix=<salome>/BLSURFPLUGIN_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:
-Note: you can use --with-blsurf option to pass the root directory of
-blsurf product to the confogure script. In this case you can avoid
-setting BLSURFHOME environment variable. Try 'configure --help'
-command to learn more about available configure script options.
+1. Set up environment for pre-requisites (see "Pre-requisites" section above).
-Check "Summary" area in the log output of the configure script to
-verify that all pre-requisites required for the successful compilation
-of BLSURFPLUFIN module have been found. All pre-requisite products
-should have status "yes". If any product has status "no", the
-compilation procedure will fail.
+2. Create a build directory:
-* compile and install plugin module
+ % mkdir BLSURFPLUGIN_BUILD
-make
-make install
+3. Configure the build procedure:
-exit
+ % cd BLSURFPLUGIN_BUILD
+ % cmake -DCMAKE_BUILD_TYPE=<mode> -DCMAKE_INSTALL_PREFIX=<installation_directory> <path_to_src_dir>
-If the compilation is finished successfully (make and make install
-steps are finished without errors) the BLSURFPLUGIN meshing module
-should be installed in the directory <salome>/BLSURFPLUGIN_INSTALL.
+ where
+ - <mode> is either Release or Debug (default: Release);
+ - <installation_directory> is a destination folder to install SALOME MG-CADSurf
+ plug-in (default: /usr);
+ - <path_to_src_dir> is a path to the SALOME MG-CADSurf plug-in sources directory.
-----------------------------------
-3. Launch SALOME with BLSURFPLUGIN
-----------------------------------
+ Note: by default (if CMAKE_INSTALL_PREFIX option is not given), SALOME MG-CADSurf
+ plug-in will be configured for installation to the /usr directory that requires
+ root permissions to complete the installation.
-* set environment
+4. Build and install:
-bash
-cd <salome>
-source env_products.sh
+ % make
+ % make install
-export BLSURFPLUGIN_ROOT_DIR=<salome>/BLSURFPLUGIN_INSTALL
-export SalomeAppConfig=${BLSURFPLUGIN_ROOT_DIR}/share/salome/resources/blsurfplugin
-export DISTENE_LICENSE_FILE=<salome>/dlim8.key
+ This will install SALOME MG-CADSurf plug-in to the <installation_directory>
+ specified to cmake command on the previous step.
-Note: DISTENE_LICENSE_FILE environment variable should point to the
-blsurf product license file.
+-------------------
+Custom installation
+-------------------
-* run SALOME
+SALOME MG-CADSurf plug-in supports a set of advanced configuration options;
+for more details learn CMakeLists.txt file in the root source directory.
-runSalome
+You can also use other options of cmake command to customize your installation.
+Learn more about available options by typing
-----------------------------
-4. BLSURFPLUGIN plugin usage
-----------------------------
+ % cmake --help
-* Create new study
+=====
+Usage
+=====
-* Activate Geometry module and create simple geometry object
+* Start SALOME.
-* Activate Mesh module
+* Create new study.
-* Invoke menu "Mesh/Create Mesh"
+* 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 "2D" page
-- In the "Algorithm" combo box select "BLSURF"
-- Click on the button at the right of the "Hypothesis" combo box and
-select "BLSURF parameters" item in the drop-down menu
+ - activate "2D" page;
+ - In the "Algorithm" combo box select "MG-CADSurf";
+ - Click on the button at the right of the "Hypothesis" combo box and
+ select "MG-CADSurf parameters" item in the drop-down menu.
-* In the "Hypothesis Construction" dialog box set parameters of BLSURF
+* In the "Hypothesis Construction" dialog box set parameters of MG-CADSurf
meshing algorithm and click "OK" button
* In the "Create mesh" dialog box Click "Apply & Close" button to
* 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 BLSURF plugin will be shown in the 3D
+The resulting mesh created with MG-CADSurf plugin will be shown in the 3D
viewer.
+
+=============
+Documentation
+=============
+
+The directory doc contains additional documentation file of SALOME MG-CADSurf
+plug-in.
+
+===============
+Troubleshooting
+===============
+
+Please, send a mail to webmaster.salome@opencascade.com.
