INSTALL

   1 #  Copyright (C) 2013  CEA/DEN, EDF R&D, OPEN CASCADE
   2 #
   3 #  Copyright (C) 2003-2007  OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
   4 #  CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
   5 #
   6 #  This library is free software; you can redistribute it and/or
   7 #  modify it under the terms of the GNU Lesser General Public
   8 #  License as published by the Free Software Foundation; either
   9 #  version 2.1 of the License.
  10 #
  11 #  This library is distributed in the hope that it will be useful,
  12 #  but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 #  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14 #  Lesser General Public License for more details.
  15 #
  16 #  You should have received a copy of the GNU Lesser General Public
  17 #  License along with this library; if not, write to the Free Software
  18 #  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  19 #
  20 #  See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
  21 #
  22
  23
  24 ------------------ Quick overview and installation instructions -----------------
  25
  26 1. SIMANIO library provides interaction of SALOME modules with SIMAN (SALOME
  27 Simulation Data Manager) server using Web Services and based on WSO2 Web Services
  28 Framework for C++ (wso2-wsf-cpp-x.x.x).
  29
  30 This library building is based on CMake build system (http://www.cmake.org/)
  31
  32 So, you have to check (or install if needed) the dependant software programs
  33 on your system:
  34 - CMake build system version 2.4 or newer
  35 - C++ compiler with standard libraries
  36 - WSO2 Web Services Framework for C++ (wso2-wsf-cpp-2.1.0)
  37
  38 If these required software are installed on your system, you should set the proper
  39 shell environment to get access to the software components
  40 (env_build.sh script).
  41
  42 2. The Generating Web Service Client Stubs using WSO2 Web Services Framework for C++
  43
  44 The properly, completelly built and installed WSO2 includes the java based tool
  45 to generate the required web services client stubs with the other supporting files
  46 from on SIMAN wsdl file. Use following parameters to generate the Axis2/C client
  47 stub code with ADB (Axis Data Binding) support :
  48   $ ./siman_service_code_generator.sh -uri ${wsdl_location} -d adb -u
  49
  50 The provided SIMANIO script (siman_service_code_generator.sh) generates the client
  51 stub files .h and .cpp from the given SIMAN wsdl file
  52 (<SIMANIO_SRC>/resources/SimanSalomeService.wsdl)
  53 and added them to the <SIMANIO_SRC>/src directory.
  54
  55 3. Then you can perform the next steps to build and install the SIMANIO library:
  56
  57   $ mkdir <SIMANIO_build>
  58   $ cd <SIMANIO_build>
  59   $ cmake -D CMAKE_INSTALL_PREFIX=<SIMANIO_install> <SIMANIO_SRC>
  60   $ make install
  61
  62 That's all.
  63
  64 Note :
  65
  66 To build SALOME KERNEL in the mode with SIMAN the SIMANIO_ROOT_DIR variable should
  67 be defined and points to the directory containing the preliminarily built and
  68 installed SIMANIO library (<SIMANIO_install>. The setting the SIMANIO_ROOT_DIR
  69 variable is provided by executing (. env_build.sh/).
  70 It can be also achieved by using the build option -DSALOME_USE_SIMAN=ON
  71 during building SALOME KERNEL.
  72
  73 Then, the SALOME components GEOM, MED, SMESH, ... implementing correpondent can be
  74 built as usual. All SALOME modules indended for communication with SIMAN should
  75 implement required interfaces as decribed in documentation
  76 (SIMAN_Integration_of_SALOME_Modules_vx.y).
  77
  78 The next section provides you with some additional info.
  79
  80 --------------------- Additional info  ----------------------
  81
  82 1. Building and installing the library basing on SALOME installation
  83
  84 The source codes of the SIMANIO library are delivered as part of the offcial
  85 SALOME installation  or can be get from CVS SIMAN repository as usual :
  86 cvs -d :pserver:<user_name>@cvs.opencascade.com:/home/server/cvs/SIMAN
  87 checkout -r V7_main SIMANIO_SRC
  88
  89 The building the library is performed using the SALOME environment and build
  90 scripts provided during SALOME installation:
  91     build.sh - SALOME build script
  92     env_build.sh - SALOME build environment script
  93     env_products.sh - SALOME run environment script
  94
  95 The dependencies and pre-requisite products as well as generation of
  96 the service clint stubs and other required files are controlled and
  97 provided by SIMANIO cmake procedure.
  98
  99 The building and installation of the SIMANIO library using the scripts are
 100 performed in accordance with the steps described above.
 101
 102 2. Testing
 103
 104 The set of the tests using this library for accesing to SIMAN server is developing
 105 and delivered separatelly. They can be properly executed when SIMAN web and database
 106 servers are configured and run.
 107
 108 3. Additional scripts
 109
 110 The directory <SIMANIO_SRC>/scripts contains environment and start scripts used
 111 for running specific SALOME modules communicatiing with SIMAN. These scripts are
 112 copied to SALOME installation root directory by the build procedure and should be
 113 adjusted if necessary (including setting the run permissions) :
 114     run_salome_siman.sh - the script used by SIMAN for SALOME running in SIMAN mode
 115     castem_env_products.sh - CASTEM module run time environment (CEA DEN request)
 116     eficas_aster_env_products.sh - EFICAS & ASTER modules run time environment
 117                                     (EDF R&D request)
 118     syrthes_env_products.sh - SYRTHES modules run time environment (EDF R&D request)
 119
 120 4. Additional customers modules communicating with SIMAN - Optional
 121
 122 These specific customers modules are delivered separatelly from SALOME
 123 installation and built in accordance with instructions provided by module
 124 responsible developers.
 125
 126 If necessary, build CEA DEN CASTEM SALOME module using the lastest modified
 127 CASTEM_SRC codes include necessary updates of script scripts (e0_donnees.py,
 128 CASTEM.py) in usual manner. Set proper value of CASTEM solver binaries location
 129 in e0_donnees.py, for example :
 130 castem_exe  = modele("castem_exe" , "<<castem10_path>/bin/castem10")
 131
 132 If necessary, build and configure EDF R&D EFICAS, ASTER and SYRTHES SALOME modules
 133 and the tools used by them : Eficasv1 (TOOL), EFICAS (MODULE used by SALOME_MECA),
 134 CODE_ASTER (TOOL), ASTER_MODULE and CODE_SYRTHES (TOOL), MODULE_SYRTHES
 135 in usual manner.
 136
 137 5. Test running SALOME without and with SIMAN mode
 138
 139 For properly built SIMANIO and SALOME modules you can check manually runnability
 140 of SALOME in two modes without and with SIMAN after setting run time environment
 141 with the escript env_products.sh as follwoing:
 142
 143 . env_products.sh
 144 . castem_env_products.sh (if necessary)
 145 . eficas_aster_env_products.sh (if necessary)
 146 . syrthes_env_products.sh (if necessary)
 147
 148 runSalome
 149 runSalome --siman
 150
 151 6. Configuration of SIMAN web server and SIMAN database server
 152
 153 Please see all necessary details concerning the configuration and running of
 154 SALOME SIMAN client and SIMAN Web server with SIMAN database in the SIMAN
 155 Administration Guide (SIMAN_AdminGuide_vX.Y).
 156
 157 7. Basic working mode of using SALOME with SIMAN server
 158
 159 If installation and configurations have been performed successfully the SIMAN server.
 160 can be accesible on SALOME client side from your browser using URL :
 161 "http://<server_name or server_IP>:8080/siman"
 162 Normally displaying the the SIMAN start page
 163
 164 SALOME in the mode with SIMAN is run automatically from the browser accessing to
 165 the SIMAN server providing all functionality defined in the SIMAN Detailed
 166 Functional Specifications for current version.
 167 (SIMAN_Functional_Specifications_vx.y).
 168