Linux/README.txt

   1 # ---------------------------------------------------------------------
   2 #
   3 # Copyright (c) CREATIS (Centre de Recherche en Acquisition et Traitement de l'Image
   4 #                        pour la Santé)
   5 # Authors : Eduardo Davila, Frederic Cervenansky, Claire Mouton
   6 #
   7 #  This software is governed by the CeCILL-B license under French law and
   8 #  abiding by the rules of distribution of free software. You can  use,
   9 #  modify and/ or redistribute the software under the terms of the CeCILL-B
  10 #  license as circulated by CEA, CNRS and INRIA at the following URL
  11 #  http://www.cecill.info/licences/Licence_CeCILL-B_V1-en.html
  12 #  or in the file LICENSE.txt.
  13 #
  14 #  As a counterpart to the access to the source code and  rights to copy,
  15 #  modify and redistribute granted by the license, users are provided only
  16 #  with a limited warranty  and the software's author,  the holder of the
  17 #  economic rights,  and the successive licensors  have only  limited
  18 #  liability.
  19 #
  20 #  The fact that you are presently reading this means that you have had
  21 #  knowledge of the CeCILL-B license and that you accept its terms.
  22 # ------------------------------------------------------------------------
  23
  24
  25
  26 #######################################
  27 To install the CreaTools under Linux, use installscript.
  28 menu.sh is deprecated. This script should not be used. (It will disappear in a near future.)
  29
  30
  31 ===================================
  32 Documentation for installscript
  33 ===================================
  34
  35 Launch 'installscript' in command line to see the list of options.
  36
  37 ===== How to Install =======
  38 0) Not forget:
  39    A. Install your ssh key: https://www.creatis.insa-lyon.fr/mywiki/SSH
  40        Note: -Put your key in .ssh directory.
  41              -Change de right of your
  42                   chmod ugo-rwx  id_dsa
  43                   chmod u+rwx id_dsa
  44    B. Send an email to the web master Fabrice Bellet <fabrice.bellet@creatis.insa-lyon.fr>
  45       to be include in the DataBase-GIT of Creatools.
  46
  47 1)
  48 ./installscript config
  49
  50 2)
  51 ./installscript 3rd
  52
  53 3)
  54 ./installscript creatools
  55
  56
  57
  58
  59
  60 ==========================================
  61 ==========================================
  62 ==========================================
  63
  64
  65 Exemples of differents configurations :
  66
  67
  68 ===== How to Install - HTML VERSION =======
  69 1)
  70 ./installscript -os Fedora -ncore 8 -gdir  $HOME/Creatis/creaTools -instprefix  $HOME/Creatis/creaTools/creatools_install -instprefix3  $HOME/Creatis/creaTools/thirdparty_install -html -build Release config
  71
  72 2) As root
  73 ./installscript 3rd
  74
  75 3)
  76 ./installscript creatools
  77
  78
  79 ===== How to Install - GIT VERSION =======
  80 0) Not forget:
  81    A. Install your ssh key: https://www.creatis.insa-lyon.fr/mywiki/SSH
  82        Note: -Put your key in .ssh directory.
  83              -Change de right of your
  84                   chmod ugo-rwx  id_dsa
  85                   chmod u+rwx id_dsa
  86    B. Send an email to the web master Fabrice Bellet <fabrice.bellet@creatis.insa-lyon.fr>
  87       to be include in the DataBase-GIT of Creatools.
  88
  89
  90 1)
  91 ./installscript -os Fedora -ncore 8 -gdir  $HOME/Creatis/creaTools -instprefix  $HOME/Creatis/creaTools/creatools_install -instprefix3  $HOME/Creatis/creaTools/thirdparty_install -git -build Release config
  92
  93 2) As root
  94 ./installscript 3rd
  95
  96 3)
  97 ./installscript creatools
  98
  99
 100
 101
 102
 103
 104 ====================================
 105
 106 -- Some examples:
 107
 108
 109 ====
 110
 111 # to configure only
 112 ./installscript -gdir $HOME/Creatis/All/creainstall config
 113 or
 114 ./installscript -git -ncore 4 -gdir $HOME/Creatis/All/creainstall config
 115
 116
 117 # to configure / compile-install all packages and the creatools themselves
 118 ./installscript -git -ncore 4 -gdir $HOME/work/creatools/creainstall all
 119
 120 # compile-install only one part (vtk  for example) ONCE CONFIG HAS BEEN RUN
 121 ./installscript 3rd-vtk
 122
 123
 124 -- If you choose Git:
 125 You must have shared your public key on Git CREATIS server.
 126 To do so, send your public SSH key to Fabrice Bellet specifying the Git repository name. You need to do it for the Git server, even if you already did it for the CVS or SVN server.
 127
 128
 129
 130 ===================================
 131 Documentation for menu.sh
 132 ===================================
 133 WARNING :
 134 Use always bash (never use sh!)
 135
 136 A) bash menu.sh
 137
 138 You will be prompted to say what you want to do :
 139
 140  Configure :........................0
 141  Install Third Party Libraries :....1 (as root)
 142  Get and Install the 'CreaTools':...2
 143  or
 144  Get the 'CreaTools' source files :.2.1 (GIT : as user!)
 145  Compile   the CreaTools :..........2.2
 146  Install   the CreaTools :..........2.3
 147
 148  Use compact menu :.................5
 149  or
 150  Use expanded menu :................5
 151  Uninstall the CreaTools :..........6
 152  Help ..............................7 Help about this menu
 153
 154  Show some Environment Variables ...8
 155  Exit :.............................9
 156
 157
 158 B) As a user, choose 'Configure' (0)
 159
 160 You will be prompted to give your preferences :
 161
 162 "Operating System : Fedora/Ubuntu/MacOS"
 163 "Number of Cores"
 164 "Name of the Generation Directory"
 165 "Boolean for Doc Generation : YES/NO"
 166 "Where do you want to get source files from : GIT/HTML"
 167
 168 -> if you chose GIT:
 169 1/ you must have shared your public key on CREATIS server
 170
 171 "GIT User name"
 172 "Login 'User' name"
 173 "Login 'Group' name"
 174 "Build type : Release/Debug"
 175 "Gdcm version : GDCM1/GDCM2"
 176 "ITK version : ITK3/ITK4"
 177
 178 Note : Currently, only GDCM1 and ITK 3 are supported.
 179
 180 C)  - Exit the menu (9).
 181     - Switch as root and run 'bash menu.sh'.
 182     - Choose 'Install Third Party Libraries' (1).
 183     - Close the terminal window.
 184
 185 D) - Open a new terminal window.
 186    - Switch as a user.
 187    - Launch 'bash menu.sh'.
 188    - Choose 'Get and Install the CreaTools source files' (2).
 189    - Close the terminal window.
 190
 191 E) Open a new terminal window.
 192    You can work, by launching creaTools.sh!