| 1 | ---------------------------------------------------------------------- |
|---|
| 2 | {{{ |
|---|
| 3 | Copyright (C) 2008 |
|---|
| 4 | |
|---|
| 5 | This file is part of Normalization plug-in package for BASE. |
|---|
| 6 | Available at http://baseplugins.thep.lu.se/ |
|---|
| 7 | BASE main site: http://base.thep.lu.se/ |
|---|
| 8 | |
|---|
| 9 | This is free software; you can redistribute it and/or |
|---|
| 10 | modify it under the terms of the GNU General Public License |
|---|
| 11 | as published by the Free Software Foundation; either version 2 |
|---|
| 12 | of the License, or (at your option) any later version. |
|---|
| 13 | |
|---|
| 14 | The software is distributed in the hope that it will be useful, |
|---|
| 15 | but WITHOUT ANY WARRANTY; without even the implied warranty of |
|---|
| 16 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
|---|
| 17 | GNU General Public License for more details. |
|---|
| 18 | |
|---|
| 19 | You should have received a copy of the GNU General Public License |
|---|
| 20 | along with this program; if not, write to the Free Software |
|---|
| 21 | Foundation, Inc., 59 Temple Place - Suite 330, |
|---|
| 22 | Boston, MA 02111-1307, USA. |
|---|
| 23 | }}} |
|---|
| 24 | ---------------------------------------------------------------------- |
|---|
| 25 | |
|---|
| 26 | == How to install the Normalization plug-ins package for BASE. == |
|---|
| 27 | |
|---|
| 28 | |
|---|
| 29 | == Requirements == |
|---|
| 30 | |
|---|
| 31 | 1. BASE 2.7.0 or later. |
|---|
| 32 | |
|---|
| 33 | |
|---|
| 34 | == Installation == |
|---|
| 35 | |
|---|
| 36 | 1. Unpack the tar.gz file to a directory of your choice. |
|---|
| 37 | 2. Copy the normalization-plugins.jar to your BASE plug-ins directory. This directory |
|---|
| 38 | is specified by the 'plugins.dir' option in your base.config file and defaults |
|---|
| 39 | to <basedir>/plugins.[[BR]] |
|---|
| 40 | If you have job agents that are running from another location, you must also |
|---|
| 41 | copy the jar file to a location the job agents has access to. |
|---|
| 42 | 3. Log in to BASE as an administrator and run the plug-in auto-installation wizard by going |
|---|
| 43 | to ''Administrate -> Plugins -> Definitions'' and click on the 'New' button. |
|---|
| 44 | 4. Select the 'Automatically' option. |
|---|
| 45 | 5. The auto-detection should find plug-ins for the algorithms listed below. You should |
|---|
| 46 | change the 'Install' value to 'yes' for those which should be installed. |
|---|
| 47 | * Average normalization |
|---|
| 48 | * Cubic spline normalization |
|---|
| 49 | * Ran invariant |
|---|
| 50 | 6. Finish the installation wizard. |
|---|
| 51 | 7. Done. The normalization plug-ins are now installed. |
|---|
| 52 | |
|---|
| 53 | Make sure that the job agents have access to the same normalization-plugins.jar file as the |
|---|
| 54 | Tomcat web server. If the job agents are not running from the same BASE |
|---|
| 55 | installation directory, you may need to copy the files to a proper location. |
|---|
| 56 | We recommend that you always put the normalization-plugins.jar inside the |
|---|
| 57 | plugins.dir directory. If you do, BASE will automatically find the JAR file |
|---|
| 58 | in job agents. Otherwise, you may have to configure the JAR path manually |
|---|
| 59 | for each job agent. |
|---|
