plugins/base2/se.lu.thep.affymetrix/trunk/INSTALL

Code
Comments
Other
Rev Date Author Line
123 12 Jul 06 jari 1 $Id$
123 12 Jul 06 jari 2
272 21 May 07 peter 3 ----------------------------------------------------------------------
272 21 May 07 peter 4 {{{
123 12 Jul 06 jari 5 Copyright (C) 2006 Jari Häkkinen
281 22 May 07 jari 6 Copyright (C) 2007 Jari Häkkinen, Peter Johansson
123 12 Jul 06 jari 7
272 21 May 07 peter 8 This file is part of se.lu.thep.affymetrix package for BASE,
272 21 May 07 peter 9 http://baseplugins.thep.lu.se/wiki/se.thep.lu.se.affymetrix
123 12 Jul 06 jari 10
272 21 May 07 peter 11 se.lu.thep.affymetrix package for BASE is free software; you can
272 21 May 07 peter 12 redistribute it and/or modify it under the terms of the GNU General
272 21 May 07 peter 13 Public License as published by the Free Software Foundation; either
272 21 May 07 peter 14 version 2 of the License, or (at your option) any later version.
123 12 Jul 06 jari 15
272 21 May 07 peter 16 se.lu.thep.affymetrix package for BASE is distributed in the hope that
272 21 May 07 peter 17 it will be useful, but WITHOUT ANY WARRANTY; without even the implied
272 21 May 07 peter 18 warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See
272 21 May 07 peter 19 the GNU General Public License for more details.
123 12 Jul 06 jari 20
123 12 Jul 06 jari 21 You should have received a copy of the GNU General Public License
123 12 Jul 06 jari 22 along with this program; if not, write to the Free Software
123 12 Jul 06 jari 23 Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307,
123 12 Jul 06 jari 24 USA.
273 21 May 07 peter 25 }}}
272 21 May 07 peter 26 ----------------------------------------------------------------------
123 12 Jul 06 jari 27
123 12 Jul 06 jari 28
272 21 May 07 peter 29 = Installation Guide for se.lu.thep.affymetrix =
272 21 May 07 peter 30
284 22 May 07 jari 31 This file contains installation information for two plug-ins: RMAExpress
272 21 May 07 peter 32 and Plier.
272 21 May 07 peter 33
345 27 Jun 07 jari 34
272 21 May 07 peter 35 == 0. Introduction ==
123 12 Jul 06 jari 36
272 21 May 07 peter 37 === Short intro: ===
123 12 Jul 06 jari 38
284 22 May 07 jari 39 The route for successful first time installation of this RMAExpress plug-in is
272 21 May 07 peter 40   i. Install the plug-in.
272 21 May 07 peter 41   i. Install wxWidgets.
272 21 May 07 peter 42   i. Install RMAExpressConsole.
272 21 May 07 peter 43   i. Make BASE aware of the new plug-in.
228 18 Jan 07 jari 44
284 22 May 07 jari 45 The route for successful first time installation of this Plier plug-in is
272 21 May 07 peter 46   i. Install the plug-in.
272 21 May 07 peter 47   i. Install apt-probeset-summarize.
272 21 May 07 peter 48   i. Make BASE aware of the new plug-in.
228 18 Jan 07 jari 49
345 27 Jun 07 jari 50 Upgrading the plug-in is even easier, see item 5 below.
228 18 Jan 07 jari 51
272 21 May 07 peter 52 === Longer intro: ===
228 18 Jan 07 jari 53
284 22 May 07 jari 54 There are two supported ways to install this Affymetrix package, you
189 27 Oct 06 jari 55 either download a pre-compiled package or you checkout the latest
189 27 Oct 06 jari 56 source from the subversion repository. The below instructions covers
189 27 Oct 06 jari 57 both installation options since major parts of the installation is the
189 27 Oct 06 jari 58 same for the different cases. There is also a source package available
189 27 Oct 06 jari 59 for download but installation from that package is currently not
189 27 Oct 06 jari 60 supported, it is supplied for reference only.
123 12 Jul 06 jari 61
272 21 May 07 peter 62 Note, the underlying algorithms RMA and Plier are not part of this
272 21 May 07 peter 63 package. This package contains the plug-in code needed for hooking up
272 21 May 07 peter 64 RMAExpress and Plier to BASE as a plug-in. The underlying binaries,
272 21 May 07 peter 65 RMAExpress and Plier, must be installed for the corresponding plug-in
272 21 May 07 peter 66 to work. See more in item 1.ii below.
156 10 Aug 06 jari 67
274 21 May 07 peter 68 If you are upgrading a previously installed RMAExpress or Plier
345 27 Jun 07 jari 69 plug-in for BASE you can safely skip to item 5 below.
124 18 Jul 06 jari 70
156 10 Aug 06 jari 71
272 21 May 07 peter 72 == 1. Pre-requisites ==
124 18 Jul 06 jari 73
274 21 May 07 peter 74 === BASE 2 ===
345 27 Jun 07 jari 75
274 21 May 07 peter 76 This plug-in package will only work with BASE 2.0 or later, i.e. BASE
274 21 May 07 peter 77 1.2.x is not (and will never be) supported.
124 18 Jul 06 jari 78
345 27 Jun 07 jari 79 ''Compile time access to BASE core jar file.''
345 27 Jun 07 jari 80
345 27 Jun 07 jari 81 This is only needed for compilation and installation from a subversion
345 27 Jun 07 jari 82 tree or a source package, i.e., it is not needed when installing a
345 27 Jun 07 jari 83 pre-compiled package.
345 27 Jun 07 jari 84
345 27 Jun 07 jari 85 Specifically, the BASE2Core.jar file in use by the server running the
345 27 Jun 07 jari 86 BASE web application must be available at compile/install time.
345 27 Jun 07 jari 87
345 27 Jun 07 jari 88
274 21 May 07 peter 89 === RMAExpressConsole and apt-probeset-summarize === 
282 22 May 07 jari 90
282 22 May 07 jari 91 ''RMAExpressConsole''
282 22 May 07 jari 92
274 21 May 07 peter 93 Pre-requisite for RMAExpress plug-in (both binary package and
345 27 Jun 07 jari 94 subversion tree installs) to work is that RMAExpressConsole is
345 27 Jun 07 jari 95 installed.
124 18 Jul 06 jari 96
272 21 May 07 peter 97 RMAExpressConsole is available in the RMAExpress package written by
272 21 May 07 peter 98 Ben Bolstad, and the official RMAExpress web site is
124 18 Jul 06 jari 99 http://rmaexpress.bmbolstad.com/
123 12 Jul 06 jari 100
345 27 Jun 07 jari 101 (Microsoft Windows instructions) RMAExpressConsole is a part of the
345 27 Jun 07 jari 102 Microsoft Windows pre-built binary package available from the
345 27 Jun 07 jari 103 RMAExpress web site. Install the package and locate the
345 27 Jun 07 jari 104 RMAExpressConsole.exe, wxbase26_gcc_custom.dll, and
345 27 Jun 07 jari 105 wxmsw26_core_gcc_custom.dll files (these will be copied to the plug-in
345 27 Jun 07 jari 106 location later).
345 27 Jun 07 jari 107
345 27 Jun 07 jari 108 (Linux and MacOSX instructions) You must download and compile
345 27 Jun 07 jari 109 RMAExpressConsole. This requires that wxWidgets (a.k.a. wxWindows) is
345 27 Jun 07 jari 110 installed on your system. wxWidgets is found at
345 27 Jun 07 jari 111 http://www.wxwidgets.org. The compilation of RMAExpressConsole is
345 27 Jun 07 jari 112 straightforward (at least on OpenSuSE 10.0 and 10.2, and MacOSX
345 27 Jun 07 jari 113 10.4.9). Download the source for v1.0beta1 and unpack the tar
280 22 May 07 jari 114 file. Unfortunately the source will not work out of the box in some
280 22 May 07 jari 115 operating systems. You have to add
280 22 May 07 jari 116 {{{
280 22 May 07 jari 117 #include <cmath>
280 22 May 07 jari 118 }}}
283 22 May 07 jari 119 to `RawDataVisualize.cpp` before issuing 'make'. After this patch
280 22 May 07 jari 120 RMAExpressConsole will be compiled (together with some other binaries
280 22 May 07 jari 121 which are of no interest here.
123 12 Jul 06 jari 122
282 22 May 07 jari 123 ''apt-probeset-summarize''
282 22 May 07 jari 124
345 27 Jun 07 jari 125 Pre-requisite for Plier plug-in (both binary package and subversion
345 27 Jun 07 jari 126 tree installs) to work is that apt-probeset_summarize is installed.
282 22 May 07 jari 127
272 21 May 07 peter 128 apt-probeset-summarize is available in the Affymetrix Power Tools
274 21 May 07 peter 129 (APT) package available through Affymetrix home page
272 21 May 07 peter 130 http://www.affymetrix.com/support/developer/powertools/index.affx
125 20 Jul 06 jari 131
274 21 May 07 peter 132 APT is available as a Windows installer package and pre-built binaries
274 21 May 07 peter 133 for Linux and Mac OS-X. If you prefer building yourself, the source
274 21 May 07 peter 134 code is available as well. Though, it should be noted, we have
274 21 May 07 peter 135 experienced some problems building APT and at the time being we have
274 21 May 07 peter 136 not succeeded.
274 21 May 07 peter 137
345 27 Jun 07 jari 138 ''Installation of external binaries''
282 22 May 07 jari 139
345 27 Jun 07 jari 140 You should install the external binaries, RMAExpressConsole (with the
345 27 Jun 07 jari 141 DLLs in case of Microsoft Windows install) and apt-probeset-summarize,
345 27 Jun 07 jari 142 such that they are readable for the user running your BASE application
345 27 Jun 07 jari 143 server. The name of the binaries MUST be `RMAExpressConsole` and
345 27 Jun 07 jari 144 `apt-probeset-summarize`, respectively. Also binaries must be copied
345 27 Jun 07 jari 145 into the same directory as the plug-in (see item 2 or 3 below
345 27 Jun 07 jari 146 depending on whether you perform a pre-compiled or source package
345 27 Jun 07 jari 147 installation). These two conditions are hard coded in the plug-ins.
272 21 May 07 peter 148
345 27 Jun 07 jari 149 The install of the BASE plug-in it-self will succeed even if this
345 27 Jun 07 jari 150 requisite is not fulfilled, but execution of the plug-in within BASE
345 27 Jun 07 jari 151 will fail.
123 12 Jul 06 jari 152
282 22 May 07 jari 153
273 21 May 07 peter 154 == 2. Compilation and installation from a subversion tree ==
123 12 Jul 06 jari 155
189 27 Oct 06 jari 156 You should skip this section if you downloaded a pre-compiled package.
123 12 Jul 06 jari 157
345 27 Jun 07 jari 158 When installing from a subversion working copy you must compile the
345 27 Jun 07 jari 159 plug-in, do
123 12 Jul 06 jari 160
273 21 May 07 peter 161   `make`
189 27 Oct 06 jari 162
273 21 May 07 peter 163 This assumes that BASE is installed in `/usr/local/base`. If this is not
135 09 Aug 06 jari 164 the case do
123 12 Jul 06 jari 165
273 21 May 07 peter 166   `make BASEROOT=<base-dir>`
123 12 Jul 06 jari 167
273 21 May 07 peter 168 where `<base-dir>` is to be replaced with the path to BASE. When the
189 27 Oct 06 jari 169 compilation finishes you install the plug-in into the BASE application
189 27 Oct 06 jari 170 server file system with
135 09 Aug 06 jari 171
273 21 May 07 peter 172   `make install`    or    `make BASEROOT=<base-dir> install`
135 09 Aug 06 jari 173
189 27 Oct 06 jari 174 The plug-in will install in the recommended directory
273 21 May 07 peter 175 `<base-dir>/www/plugins/se/lu/thep/affymetrix`, i.e., if you prefer
189 27 Oct 06 jari 176 another location please refer to the Makefile (which supports further
189 27 Oct 06 jari 177 options).
124 18 Jul 06 jari 178
273 21 May 07 peter 179 For advanced users only: `<base-dir>` can really be any directory
189 27 Oct 06 jari 180 readable for the user running your tomcat server. This may be handy if
189 27 Oct 06 jari 181 you run several servers on one machine but only want one common
189 27 Oct 06 jari 182 directory hierarchy for the plug-ins. Or, if you update the BASE
189 27 Oct 06 jari 183 application frequently and in the process create new directories for
189 27 Oct 06 jari 184 the newer application. More information about this is available in the
189 27 Oct 06 jari 185 Makefile.
189 27 Oct 06 jari 186
189 27 Oct 06 jari 187 Remember the plug-in location for configuration of BASE below.
189 27 Oct 06 jari 188
189 27 Oct 06 jari 189
273 21 May 07 peter 190 == 3. Installation from a pre-compiled package ==
189 27 Oct 06 jari 191
345 27 Jun 07 jari 192 You should skip this section if you use the subversion repository or a
345 27 Jun 07 jari 193 source package.
189 27 Oct 06 jari 194
345 27 Jun 07 jari 195 Install the plug-in in the BASE application server file system. If
273 21 May 07 peter 196 BASE is installed in `/usr/local/base` simply do
124 18 Jul 06 jari 197
273 21 May 07 peter 198   `make install-precompiled`
123 12 Jul 06 jari 199
135 09 Aug 06 jari 200 If BASE is installed elsewhere, do
135 09 Aug 06 jari 201
273 21 May 07 peter 202   `make BASEROOT=<base-dir> install-precompiled`
135 09 Aug 06 jari 203
273 21 May 07 peter 204 where `<base-dir>` is to be replaced by the path to BASE. The plug-in
123 12 Jul 06 jari 205 will install in the recommended directory
273 21 May 07 peter 206 `<base-dir>/www/plugins/se/lu/thep/affymetrix`, i.e., if you prefer
189 27 Oct 06 jari 207 another location please refer to the Makefile (which supports further
189 27 Oct 06 jari 208 options).
123 12 Jul 06 jari 209
425 12 Sep 07 jari 210 (Microsoft Windows instructions) If the above fails, or you decided to
425 12 Sep 07 jari 211 use a something else than a UNIX like operating system you may have
425 12 Sep 07 jari 212 difficulties running GNU `make`. Simply create directory
425 12 Sep 07 jari 213 `<base-dir>/www/plugins/se/lu/thep/affymetrix` and copy
425 12 Sep 07 jari 214 `affymetrix.jar` into the new directory.
425 12 Sep 07 jari 215
273 21 May 07 peter 216 For advanced users only: `<base-dir>` can really be any directory
125 20 Jul 06 jari 217 readable for the user running your tomcat server. This may be handy if
125 20 Jul 06 jari 218 you run several servers on one machine but only want one common
125 20 Jul 06 jari 219 directory hierarchy for the plug-ins. Or, if you update the BASE
125 20 Jul 06 jari 220 application frequently and in the process create new directories for
135 09 Aug 06 jari 221 the newer application. More information about this is available in the
135 09 Aug 06 jari 222 Makefile.
124 18 Jul 06 jari 223
153 10 Aug 06 jari 224 Remember the plug-in location for configuration of BASE below.
125 20 Jul 06 jari 225
125 20 Jul 06 jari 226
273 21 May 07 peter 227 == 4. BASE configuration ==
124 18 Jul 06 jari 228
345 27 Jun 07 jari 229 === Make BASE aware of the new plug-ins ===
125 20 Jul 06 jari 230
282 22 May 07 jari 231 You need to perform the below steps for both plug-ins in this
282 22 May 07 jari 232 package. Currently there is no way to install all plug-ins in one
282 22 May 07 jari 233 package.
282 22 May 07 jari 234
284 22 May 07 jari 235  * Log in to BASE with plug-in administrative privileges.
127 22 Jul 06 jari 236
273 21 May 07 peter 237  * Choose 'Administrate' -> 'Plugins' -> 'Definitions'.
127 22 Jul 06 jari 238
273 21 May 07 peter 239  * Click on 'New...'. This will open up the 'Create plugin' pop-up
282 22 May 07 jari 240    window. Type `se.lu.thep.affymetrix.RMAExpress` in the 'Class'
189 27 Oct 06 jari 241    field and
282 22 May 07 jari 242    `/path/to/base/www/plugins/se/lu/thep/affymetrix/affymetrix.jar" in
284 22 May 07 jari 243    the 'Path' field. Obviously, if you have chosen another location
282 22 May 07 jari 244    for the jar above you should adapt to that. Click on the 'Save'
282 22 May 07 jari 245    button.
127 22 Jul 06 jari 246
282 22 May 07 jari 247  * Share the plug-in to all users/roles/groups that should have access
282 22 May 07 jari 248    to it (sharing it to group 'Everyone' should be sufficient in most
282 22 May 07 jari 249    cases).
127 22 Jul 06 jari 250
295 23 May 07 jari 251  * Redo the third and fourth step above for Plier where you use
295 23 May 07 jari 252    `se.lu.thep.affymetrix.Plier` in the class field.
127 22 Jul 06 jari 253
273 21 May 07 peter 254  * That's it, now you need to BASE skills to actually make use of the
282 22 May 07 jari 255    plug-in.
125 20 Jul 06 jari 256
345 27 Jun 07 jari 257
281 22 May 07 jari 258 == 5. Updating a plug-in in BASE. ==
127 22 Jul 06 jari 259
273 21 May 07 peter 260 You may update the underlying binaries (RMAExpress or
273 21 May 07 peter 261 apt-probeset-summarize) or the plug-in.
153 10 Aug 06 jari 262
273 21 May 07 peter 263 ===  Updating RMAExpressConsole or apt-probeset-summarize ===
156 10 Aug 06 jari 264
273 21 May 07 peter 265 Installing a new binary is trivial, just replace the old binary with
282 22 May 07 jari 266 the new binary. However, make sure that the input and output formats
282 22 May 07 jari 267 has not changed.
156 10 Aug 06 jari 268
273 21 May 07 peter 269 ===  Update RMAExpress or Plier plug-ins for BASE ===
156 10 Aug 06 jari 270
284 22 May 07 jari 271 This is straightforward:
156 10 Aug 06 jari 272
345 27 Jun 07 jari 273  - Replace the old jar-file and
156 10 Aug 06 jari 274
345 27 Jun 07 jari 275  - Log in to BASE with plug-in administrative privileges.
156 10 Aug 06 jari 276
345 27 Jun 07 jari 277  - Choose 'Administrate' -> 'Plugins' -> 'Definitions'.
156 10 Aug 06 jari 278
345 27 Jun 07 jari 279  - Locate the plug-in (RMAExpress or Plier) in the list and click on it.
156 10 Aug 06 jari 280
345 27 Jun 07 jari 281  - Click on the 'Unload' button if it is available. This will
345 27 Jun 07 jari 282    remove the old plug-in from the application.
156 10 Aug 06 jari 283
345 27 Jun 07 jari 284  - Click on 'Edit...'. This will open up the 'Edit plugin'
345 27 Jun 07 jari 285    pop-up window. No parameter changes are need, just click on
345 27 Jun 07 jari 286    the 'Save' button.
156 10 Aug 06 jari 287
345 27 Jun 07 jari 288  - Done.

Generated on Tue Nov 21 03:44:02 2023 (UTC) by svndigest 0.11.2pre (dev build 1672)