source: plugins/base2/net.sf.basedb.normalizations/trunk/INSTALL @ 739

Copyright (C) 2008
This file is part of Normalization plug-in package for BASE.
Available at http://baseplugins.thep.lu.se/
BASE main site: http://base.thep.lu.se/
This is free software; you can redistribute it and/or
modify it under the terms of the GNU General Public License
as published by the Free Software Foundation; either version 2
of the License, or (at your option) any later version.
The software is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 59 Temple Place - Suite 330,
Boston, MA  02111-1307, USA.

How to install the Normalization plug-ins package for BASE.

Requirements

1. BASE 2.7.0 or later.

Installation

1. Unpack the tar.gz file to a directory of your choice.
2. Copy the normalization-plugins.jar to your BASE plug-ins directory. This directory is specified by the 'plugins.dir' option in your base.config file and defaults to <basedir>/plugins.
   If you have job agents that are running from another location, you must also copy the jar file to a location the job agents has access to.
3. Log in to BASE as an administrator and run the plug-in auto-installation wizard by going

to Administrate -> Plugins -> Definitions and click on the 'New' button.

4. Select the 'Automatically' option.
5. The auto-detection should find plug-ins for the algorithms listed below. You should change the 'Install' value to 'yes' for those which should be installed.
   • Average normalization
   • Cubic spline normalization
   • Ran invariant
6. Finish the installation wizard.
7. Done. The normalization plug-ins are now installed.

Make sure that the job agents have access to the same normalization-plugins.jar file as the Tomcat web server. If the job agents are not running from the same BASE installation directory, you may need to copy the files to a proper location. We recommend that you always put the normalization-plugins.jar inside the plugins.dir directory. If you do, BASE will automatically find the JAR file in job agents. Otherwise, you may have to configure the JAR path manually for each job agent.