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
  48 1)
  49 ./installscript all
  50
  51 .....That's all  :-).....
  52
  53
  54
  55
  56 ======= Update creatools   =======
  57 ./installscript creatools
  58
  59
  60
  61
  62
  63
  64 ==========================================
  65 ==========================================
  66 ==========================================
  67
  68
  69 Exemples of differents configurations :
  70
  71 1)
  72 ./installscript config
  73 You can check the configuration in scripts/CreaTools-configure.sh
  74
  75 2)
  76 ./installscript 3rd
  77
  78 3)
  79 ./installscript creatools
  80
  81
  82
  83
  84
  85 ==========================================
  86 ==========================================
  87 ==========================================
  88
  89
  90 Exemples of differents configurations :
  91
  92
  93 ===== How to Install - HTML VERSION =======
  94 1)
  95 ./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
  96
  97 2) As root
  98 ./installscript 3rd
  99
 100 3)
 101 ./installscript creatools
 102
 103
 104 ===== How to Install - GIT VERSION =======
 105 0) Not forget:
 106    A. Install your ssh key: https://www.creatis.insa-lyon.fr/mywiki/SSH
 107        Note: -Put your key in .ssh directory.
 108              -Change de right of your
 109                   chmod ugo-rwx  id_dsa
 110                   chmod u+rwx id_dsa
 111    B. Send an email to the web master Fabrice Bellet <fabrice.bellet@creatis.insa-lyon.fr>
 112       to be include in the DataBase-GIT of Creatools.
 113
 114
 115 1)
 116 ./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
 117
 118 2) As root
 119 ./installscript 3rd
 120
 121 3)
 122 ./installscript creatools
 123
 124
 125
 126
 127
 128
 129 ====================================
 130
 131 -- Some examples:
 132
 133
 134 ====
 135
 136 # to configure only
 137 ./installscript -gdir $HOME/Creatis/All/creainstall config
 138 or
 139 ./installscript -git -ncore 4 -gdir $HOME/Creatis/All/creainstall config
 140
 141
 142 # to configure / compile-install all packages and the creatools themselves
 143 ./installscript -git -ncore 4 -gdir $HOME/work/creatools/creainstall all
 144
 145 # compile-install only one part (vtk  for example) ONCE CONFIG HAS BEEN RUN
 146 ./installscript 3rd-vtk
 147
 148
 149 -- If you choose Git:
 150 You must have shared your public key on Git CREATIS server.
 151 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.
 152
 153
 154
 155 ===================================
 156 Documentation for menu.sh
 157 ===================================
 158 WARNING :
 159 Use always bash (never use sh!)
 160
 161 A) bash menu.sh
 162
 163 You will be prompted to say what you want to do :
 164
 165  Configure :........................0
 166  Install Third Party Libraries :....1 (as root)
 167  Get and Install the 'CreaTools':...2
 168  or
 169  Get the 'CreaTools' source files :.2.1 (GIT : as user!)
 170  Compile   the CreaTools :..........2.2
 171  Install   the CreaTools :..........2.3
 172
 173  Use compact menu :.................5
 174  or
 175  Use expanded menu :................5
 176  Uninstall the CreaTools :..........6
 177  Help ..............................7 Help about this menu
 178
 179  Show some Environment Variables ...8
 180  Exit :.............................9
 181
 182
 183 B) As a user, choose 'Configure' (0)
 184
 185 You will be prompted to give your preferences :
 186
 187 "Operating System : Fedora/Ubuntu/MacOS"
 188 "Number of Cores"
 189 "Name of the Generation Directory"
 190 "Boolean for Doc Generation : YES/NO"
 191 "Where do you want to get source files from : GIT/HTML"
 192
 193 -> if you chose GIT:
 194 1/ you must have shared your public key on CREATIS server
 195
 196 "GIT User name"
 197 "Login 'User' name"
 198 "Login 'Group' name"
 199 "Build type : Release/Debug"
 200 "Gdcm version : GDCM1/GDCM2"
 201 "ITK version : ITK3/ITK4"
 202
 203 Note : Currently, only GDCM1 and ITK 3 are supported.
 204
 205 C)  - Exit the menu (9).
 206     - Switch as root and run 'bash menu.sh'.
 207     - Choose 'Install Third Party Libraries' (1).
 208     - Close the terminal window.
 209
 210 D) - Open a new terminal window.
 211    - Switch as a user.
 212    - Launch 'bash menu.sh'.
 213    - Choose 'Get and Install the CreaTools source files' (2).
 214    - Close the terminal window.
 215
 216 E) Open a new terminal window.
 217    You can work, by launching creaTools.sh!