Salome HOME
updated scripts
[tools/simanio.git] / scripts / README
index 16702b79d359858fda9d1ab25949570723a95009..d26b9644bc7a242972edb900fb1dfaca49641fd2 100644 (file)
@@ -1,30 +1,73 @@
-How prepare runnable SALOME-SIMAN code
+How to get and build SALOME-SIMAN code
 
-1. Use standard SALOME 6.5.0 disctibutive for installation.
+1. Take SALOME-SIMAN code from CVS repository for SIMAN.
+and the following modules "KERNEL GUI GEOM MED SMESH PYHELLO" like this
 
-2. Take from CVS SALOME-SIMAN code for branch "BR_siman_phase1" based on SALOME 6.5.0
+cvs -d :pserver:<user_name>@cvs.opencascade.com:/home/server/cvs/SIMAN checkout SIMANIO_SRC
+cvs -d :pserver:<user_name>@cvs.opencascade.com:/home/server/cvs/KERNEL checkout -r <branch name> KERNEL_SRC
+cvs -d :pserver:<user_name>@cvs.opencascade.com:/home/server/cvs/GUI checkout -r <branch name> GUI_SRC
+cvs -d :pserver:<user_name>@cvs.opencascade.com:/home/server/cvs/GEOM checkout -r <branch name> GEOM_SRC
+cvs -d :pserver:<user_name>@cvs.opencascade.com:/home/server/cvs/MED checkout -r <branch name> MED_SRC
+cvs -d :pserver:<user_name>@cvs.opencascade.com:/home/server/cvs/SMESH checkout -r <branch name> SMESH_SRC
+cvs -d :pserver:<user_name>@cvs.opencascade.com:/home/server/cvs/EXAMPLES checkout -r <branch name> PYHELLO1_SRC
+(rename the directory PYHELLO1_SRC to PYHELLO_SRC)
 
-startinmg from SIMAN repository like :
-cvs -d :pserver:bri@cvs.opencascade.com:/home/server/cvs/SIMAN checkout -r BR_siman_phase1 SIMANIO_SRC
+where <branch name> is :
+"BR_siman_phase1" if you are based on SALOME 6.5.0
+"V7_siman" if you are based on SALOME 7.X
 
-Move the required product wso2-wsf-cpp-2.1.0 and all scripts to SALOME root directory
-Adjust the scripts if necessary
+2. Copy the required WSO2 Web Services product : copy the folder wso2-wsf-cpp-2.1.0 (including source and binary build for correspondent target platforms) from SALOME-SIMAN binary delivery to the current build directory.
+You can also build this product using provided product sources and documentation.
 
-Take from CVS other modules like it is done in SALOME_CVS_checkout_branch_BR_siman_phase1.sh
-"KERNEL GUI GEOM MED SMESH VISU PARAVIS YACS NETGENPLUGIN GHS3DPLUGIN BLSURFPLUGIN HexoticPLUGIN GHS3DPRLPLUGIN PYHELLO"
+3. Copy the required scripts from SIMANIO_SRC/scripts directory to root directory (../..) and adjust them as necessary, including setting the run permissions
+build.sh - SALOME build script
+env_build.sh - SALOME build environment
+env_products.sh - SALOME run environment
+env_build_mandiva-2010-64.sh - SALOME build environment for Mandriva 2010-64
+env_products_mandriva-2010-64.sh - SALOME run environment for Mandriva 2010-64
+README - this file
+env_siman.sh - SIMAN (SIMANIO) build environment
+siman_build.sh - SIMAN (SIMANIO) build script
+castem_env_products.sh - CASTEM run environment
+eficas_aster_env_products.sh - EFICAS & ASTER run environment
+syrthes_env_products.sh - SYRTHES run environment
+run_salome_siman.sh - the script used by SIMAN for SALOME running in the SIMAN mode
 
-3. Build all modules starting from SIMANIO_SRC using the scripts
+For Mandriva 2010-64 rename and use env_build_mandiva-2010-64.sh env_products_mandriva-2010-64.sh.
+This README file is also delivered in SIMANIO_SRC/scripts directory
 
-4. Check runnability of Salome
+4. Build SIMANIO_SRC using these scripts as following :
+. env_siman.sh 
+./siman_build.sh
 
-5. Define (export) the environment variable SALOME_ROOT_DIR pointing to the directory there SALOME and scripts are build.
-in .bashrc file
+5. Then build other required SALOME modules in usual manner 
+for example, using the scripts provided with offical SALOME installation (env_build.sh, env_products.sh, build.sh)
 
-6. If necessary run SIMAN application servers 
-/usr/share/tomcat6/bin/startup.sh
-to stop use 
-/usr/share/tomcat6/bin/shutdown.sh
+Note :
+To build SALOME in the mode with SIMAN the SIMANIO_ROOT_DIR variable has to be defined and points to directory containing the include files and the preliminarily built SIMANIO library.
+It is used by configure in the conditional WITH_SIMANIO and CHECK_SIMANIO m4 check procedure.
 
-In the file env_siman.sh adjust SIMAN_WS_HOST variable to point to SIMAN application server
+The setting the SIMANIO_ROOT_DIR variable is provided by executing (. env_siman.sh) on the previous step and it is enough to build properly SALOME KERNEL with SIMAN.
 
+It can be also achieved by usage of the configure option --with-simanio=$SIMANIO_ROOT_DIR.
+
+Additionally the following SALOME modules (not currently impacted with SIMAN changes) can be also built to using in SIMAN project test cases.
+"VISU PARAVIS YACS NETGENPLUGIN GHS3DPLUGIN BLSURFPLUGIN HexoticPLUGIN GHS3DPRLPLUGIN"
+
+6. If necessary, build CASTEM SALOME module in usual manner
+Use modified CASTEM_SRC codes include necessary updates of script scripts (e0_donnees.py, CASTEM.py)
+Set proper value of CASTEM solver binaries location in e0_donnees.py, for example
+castem_exe  = modele("castem_exe"   , "/data/SIMAN/_CEA_V7_siman_6.6.0/castem10/bin/castem10")
+
+7. If necessary, build and configure EFICAS, ASTER and SYRTHES SALOME modules and the tools used by them :
+Eficasv1 (TOOL), EFICAS (MODULE used by SALOME_MECA), CODE_ASTER (TOOL), ASTER_MODULE and CODE_SYRTHES (TOOL), MODULE_SYRTHES
+in usual manner as described in INSTALL_Applications.txt by Cedric AGUERRE, EDF R&D.
+
+8. Set SALOME runtime environment and Check runnability of SALOME in two modes - without and with SIMAN :
+. env_siman.sh
+. castem_env_products.sh (if necessary)
+. eficas_aster_env_products.sh (if necessary)
+. syrthes_env_products.sh (if necessary)
+runSalome
+runSalome --siman