X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=README;h=716d15c136b3322cc003944a5396b0e13489df7f;hb=a331ad4c5cd665ab4f33f4ac132ab55ce9a0a3eb;hp=d6e14d78a63cce42bb88faa622ce6c36e441d589;hpb=2b465e94ae4ec5322dd9cff7ba1d1cc2cc6abe3f;p=plugins%2Fhexoticplugin.git diff --git a/README b/README index d6e14d7..716d15c 100644 --- a/README +++ b/README @@ -1,128 +1,147 @@ -SALOME platform -Hexotic meshing plugin ------------------------------- +**************************** +About SALOME MG-Hexa plug-in +**************************** -Contents: +SALOME MG-Hexa plug-in adds DISTENE MG-Hexa (former Hexotic) +meshing algorithm to the SALOME Mesh module. -1. Pre-requisites -2. Installation -3. Launch SALOME with HexoticPLUGIN -4. HexoticPLUGIN plugin usage +MG-Hexa plug-in is destined for: +- Meshing of 3D geometric entities with hexahedra; +- Generating 3D meshes from 2D meshes, working without geometrical objects. ------------------ -1. Pre-requisites ------------------ +For more information please visit the SALOME platform web site: -The information in this file assumes that: + -* The SALOME platform is installed to the directory -* The Hexotic product is installed to the directory /Hexotic +======= +License +======= ---------------- -2. Installation ---------------- +SALOME platform is distributed under the GNU Lesser General Public License. +See COPYING file for more details. -2.1. Unpack HexoticPLUGIN module sources +Also, additional information can be found at SALOME platform web site: -cd -tar zxf HexoticPLUGIN_SRC.tgz + -2.2. Build HexoticPLUGIN module +============ +Installation +============ -* set environment +-------------- +Pre-requisites +-------------- -bash -cd -source env_build.sh -export HexoticHOME=/Hexotic +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. -Note: you can avoid setting HexoticHOME environment variable but use ---with-hexotic key of configure script instead. You can also compile -plugin withour Hexotic product installation. But you'll need to add -path to the hexotic executable to the PATH environment variable in order -to use Hexotic meshing plugin within SALOME. +For more information about the pre-requisites please visit SALOME platform web +site: -* configure build system +* Check Release Notes and Software Requirements of the latest SALOME release at -cd HexoticPLUGIN_SRC -./build_configure + -cd .. -mkdir HexoticPLUGIN_BUILD -cd HexoticPLUGIN_BUILD -../HexoticPLUGIN_SRC/configure --prefix=/HexoticPLUGIN_INSTALL +* Pre-requisites page at SALOME web site: -Note: you can use --with-hexotic option to pass the root directory of -Hexotic product to the configure script. In this case you can avoid -setting HexoticHOME environment variable. Try 'configure --help' -command to learn more about available configure script options. + -Check "Summary" area in the log output of the configure script to -verify that all pre-requisites required for the successful compilation -of HexoticPLUFIN module have been found. All pre-requisite products -should have status "yes". If any product has status "no", the -compilation procedure will fail (the only exception is Hexotic -product which is not required for the successful compilation of the -plugin; it is needed in run-time only). +Note: SALOME MG-Hexa plug-in needs SALOME KERNEL, SALOME GUI, SALOME Geometry, +SALOME Mesh and, optionally, SALOME MG-CADSurf plug-in as pre-requisites. -* compile and install plugin module +------------------ +Basic Installation +------------------ -make -make 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: -exit +1. Set up environment for pre-requisites (see "Pre-requisites" section above). -If the compilation is finished successfully (make and make install -steps are finished without errors) the HexoticPLUGIN meshing module -should be installed in the directory /HexoticPLUGIN_INSTALL. +2. Create a build directory: ------------------------------------ -3. Launch SALOME with HexoticPLUGIN ------------------------------------ + % mkdir HexoticPLUGIN_BUILD -* set environment +3. Configure the build procedure: -bash -cd -source env_products.sh + % cd HexoticPLUGIN_BUILD + % cmake -DCMAKE_BUILD_TYPE= -DCMAKE_INSTALL_PREFIX= -export HexoticPLUGIN_ROOT_DIR=/HexoticPLUGIN_INSTALL -export SalomeAppConfig=${HexoticPLUGIN_ROOT_DIR}/share/salome/resources/hexoticplugin -export PATH=/Hexotic:${PATH + where + - is either Release or Debug (default: Release); + - is a destination folder to install SALOME MG-Hexa + plug-in (default: /usr); + - is a path to the SALOME MG-Hexa plug-in sources + directory. -* run SALOME + Note: by default (if CMAKE_INSTALL_PREFIX option is not given), SALOME MG-Hexa + plug-in will be configured for installation to the /usr directory that + requires root permissions to complete the installation. -runSalome +4. Build and install: ------------------------------ -4. HexoticPLUGIN plugin usage ------------------------------ + % make + % make install -* Create new study + This will install SALOME MG-Hexa plug-in to the + specified to cmake command on the previous step. -* Activate Geometry module and create simple geometry object +------------------- +Custom installation +------------------- -* Activate Mesh module +SALOME MG-Hexa plug-in supports a set of advanced configuration options; +for more details learn CMakeLists.txt file in the root source directory. -* Invoke menu "Mesh/Create Mesh" +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 "Hexotic" -- Click on the button at the right of the "Hypothesis" combo box and -select "Hexotic parameters" item in the drop-down menu + - Activate "3D" page; + - In the "Algorithm" combo box select "MG-Hexa"; + - Click on the button at the right of the "Hypothesis" combo box and + select "MG-Hexa Parameters" item in the drop-down menu. -* In the "Hypothesis Construction" dialog box set parameters of Hexotic - meshing algorithm and click "OK" button +* In the "Hypothesis Construction" dialog box set parameters of MG-Hexa + 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 Hexotic plugin will be shown in the 3D +The resulting mesh created with MG-Hexa plugin will be shown in the 3D viewer. + +============= +Documentation +============= + +The directory doc contains additional documentation file of SALOME MG-Hexa +plug-in. + +=============== +Troubleshooting +=============== + +Please, send a mail to webmaster.salome@opencascade.com.