Workspace/INSTALL

   1 #  Copyright (C) 2013-2015  CEA/DEN, EDF R&D, OPEN CASCADE
   2 #
   3 #  This library is free software; you can redistribute it and/or
   4 #  modify it under the terms of the GNU Lesser General Public
   5 #  License as published by the Free Software Foundation; either
   6 #  version 2.1 of the License, or (at your option) any later version.
   7 #
   8 #  This library is distributed in the hope that it will be useful,
   9 #  but WITHOUT ANY WARRANTY; without even the implied warranty of
  10 #  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  11 #  Lesser General Public License for more details.
  12 #
  13 #  You should have received a copy of the GNU Lesser General Public
  14 #  License along with this library; if not, write to the Free Software
  15 #  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  16 #
  17 #  See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
  18 #
  19
  20 ---------------
  21 1. Introduction
  22 ---------------
  23
  24 SIMAN (SALOME Simulation Data Manager) Java based server provides functionality
  25 for data management and interaction with client SALOME modules (having
  26 implemented interfaces for interaction) using SIMAN Web Services and the SimanIO
  27 library.
  28
  29 ---------------
  30 2. Installation
  31 ---------------
  32
  33 2.1 Pre-requisites
  34
  35 The SIMAN server building is based on the standard for Java ant build system
  36 (http://ant.apache.org).
  37
  38 This means that you have to check (or install if needed) the required software
  39 on your system:
  40 - Java development environment (jdk 1.6.0, of example java-6-openjdk)
  41 - and Java build environment (ant 1.7.1, Apache Ant version 1.7.1)
  42
  43 2.2. Building the SIMAN Java libraries and the SIMAN Server Web archive
  44 - siman.war
  45
  46 To build all SIMAN required libraries and web archives you will have to extract
  47 the source package in a directory where you have write permissions:
  48
  49      $ tar xzf siman-x.y.z.tar.gz         (x.y.z is a version signature)
  50
  51 After that, you will need to perform the following actions to build all libraries
  52 and the SIMAN Server Web archive - siman.war including these libraries:
  53
  54      - go to the directory Siman (../SIMAN_SRC/Workspace/Siman)
  55      - adjust the paths to ANT bin folder, JAVA_HOME as well as required RDBMS
  56        (prepare-mysql or prepare-postgres) and Workflows (prepare-edf or
  57        prepare-cea) in the file build-war.bat or build-war.sh
  58      - run script build-war.bat or build-war.sh
  59      - the result web archive siman.war is created in sub-directory dist
  60        (../SIMAN_SRC/Workspace/Siman/dist)
  61
  62
  63 2.3. Building the SIMAN Java libraries and the SIMAN Web Services Web archive
  64 - Siman-WS.war
  65
  66 Then you will need to perform the following actions to build all libraries
  67 and the SIMAN Web Services Web archive - Siman-WS.war including these libraries:
  68
  69      - go to the directory Siman-WS (../SIMAN_SRC/Workspace/Siman-WS)
  70      - adjust the paths to ANT bin folder, JAVA_HOME as well as required RDBMS
  71        (prepare-mysql or prepare-postgres) and Workflows (prepare-edf or
  72        prepare-cea) in the file build-war.bat or build-war.sh
  73      - run script build-war.bat or build-war.sh
  74      - the result web archive Siman-WS.war is created in sub-directory dist
  75        (../SIMAN_SRC/Workspace/Siman-WS/dist)
  76
  77 2.4. Both SIMAN Web archives are deployed to the Web server and to be properly
  78 configured. See details in APPENDIX.
  79
  80 -----------
  81 3. APPENDIX
  82 -----------
  83
  84 This paragraph provides some additional information about the SIMAN server
  85 building, configuration and testing.
  86
  87 3.1. Building the SIMAN Java libraries and the SIMAN Web archives basing on
  88 SALOME installation
  89
  90 The source code of the SIMAN Server is delivered as part of the official
  91 SALOME distribution; alternatively it can be obtained from CVS repository:
  92
  93     $ cvs -d :pserver:<user_name>@cvs.opencascade.com:/home/server/cvs/SIMAN
  94     $ cvs checkout -PRA SIMAN_SRC
  95
  96 Building of the SIMAN Java libraries and the SIMAN Web archives is performed
  97 in accordance with the procedure described above (paragraph 2).
  98
  99 3.2. Unit Testing
 100
 101 The set of the server side unit tests for main SIMAN server functionality is
 102 provided in the directory ../SIMAN_SRC/Workspace/Siman-Common/src/test/splat.
 103
 104 3.3. Installation of SIMAN Web archives and Configuration of SIMAN web server
 105 and SIMAN database server.
 106
 107 Please see all necessary details concerning the configuration and running of
 108 SALOME SIMAN client and SIMAN Web server with SIMAN database server in the
 109 SIMAN Administration Guide (SIMAN_AdminGuide_vx.y).
 110
 111 3.4. Basic working mode of using SALOME with SIMAN server
 112
 113 If installation and configurations have been performed successfully
 114 the SIMAN server can be accessible on SALOME client side from your browser using
 115 URL : "http://<server_name or server_IP>:8080/siman"
 116 Normally displaying the SIMAN start page
 117
 118 SALOME session connected to SIMAN is automatically started from the browser;
 119 this SALOME session will access SIMAN server providing all functionality defined
 120 in the SIMAN Detailed Functional Specifications for the current version of SIMAN
 121 (see SIMAN_Functional_Specifications_vx.y).
 122