plugins/base2/net.sf.basedb.illumina/trunk/INSTALL

Code
Comments
Other
Rev Date Author Line
1236 31 Aug 10 jari 1 = How to install or upgrade the Illumina plug-ins package for BASE. =
576 07 Feb 08 martin 2
576 07 Feb 08 martin 3
576 07 Feb 08 martin 4 == Requirements ==
553 25 Jan 08 nicklas 5
1386 06 Sep 11 nicklas 6  1. BASE 3.0 or later.
553 25 Jan 08 nicklas 7
576 07 Feb 08 martin 8
576 07 Feb 08 martin 9 == Installation ==
576 07 Feb 08 martin 10
576 07 Feb 08 martin 11  1. Unpack the tar.gz file to a directory of your choice. 
576 07 Feb 08 martin 12  2. Stop your Tomcat server that is running BASE and all job agents, if any.
1386 06 Sep 11 nicklas 13  3. Copy the illumina-plugins.jar to your BASE plug-ins directory. Look in your 
1386 06 Sep 11 nicklas 14     'base.config' file if you don't know where this is.[[BR]]   
629 13 Mar 08 nicklas 15     If you have job agents that are running from another location, you must also 
1386 06 Sep 11 nicklas 16     copy the jar file to the plug-in directory that the job agents use (if that is
1386 06 Sep 11 nicklas 17     different).   
1236 31 Aug 10 jari 18  4. From the ''config'' directory, copy ('''Notice: If you have job
1236 31 Aug 10 jari 19     agents running from another location, copy the configuration files
1236 31 Aug 10 jari 20     to a location the job agents has access to.'''):
583 12 Feb 08 nicklas 21      * ''illumina-extended-properties.xml'' to <basedir>''/www/WEB-INF/classes/extended-properties/''
1236 31 Aug 10 jari 22      * ''illumina-raw-data-types-xml'' to <basedir>''/www/WEB-INF/classes/raw-data-types/''
576 07 Feb 08 martin 23  5. Update the database with Illumina-specific tables and columns by running the
583 12 Feb 08 nicklas 24     ''updatedb.sh'' script, located in the <basedir>''/bin'' directory.
1386 06 Sep 11 nicklas 25  6. Restart the Tomcat server. 
1386 06 Sep 11 nicklas 26  7. Go to 'Administrate->Plug-ins & Extensions->Overview' page.
1386 06 Sep 11 nicklas 27  8. Run the installation wizard and select to install 'illumina-plugins.jar'.
1386 06 Sep 11 nicklas 28  9. Find the 'Illumina plug-in package installer' in the list of plug-ins and click on it.
1386 06 Sep 11 nicklas 29  10. Click on the 'Run plugin' button.
1386 06 Sep 11 nicklas 30  11. Decide which Illumina variants to install and if you want the installation 
1386 06 Sep 11 nicklas 31      program to create a scanner and/or software entry.
1386 06 Sep 11 nicklas 32  12. Finish the job registration and wait for the plug-in to finish.
1386 06 Sep 11 nicklas 33  13. Done. The Illumina plug-ins and extensions are now installed. You can 
1386 06 Sep 11 nicklas 34      now restart any job agents as well.
1166 28 Sep 09 jari 35  16. Optionally, if not already done, disable use of the 'Illumina'
1166 28 Sep 09 jari 36     raw data type provided by a standard BASE installation; Simply
1166 28 Sep 09 jari 37     remove, or comment out, the `<raw-data-type>` entry for
1166 28 Sep 09 jari 38     `id='illumina'` in configuration file
1166 28 Sep 09 jari 39     `/path/to/base/WEB-INF/classes/raw-data-types.xml` and restart the
1166 28 Sep 09 jari 40     BASE server. If a user already used the 'Illumina' raw data type,
1166 28 Sep 09 jari 41     BASE will display an error message in the GUI. Either restore the
1166 28 Sep 09 jari 42     use of 'Illumina' raw data type or remove the data using
1166 28 Sep 09 jari 43     'Illumina' raw data type.
553 25 Jan 08 nicklas 44     
629 13 Mar 08 nicklas 45 Make sure that the job agents have access to the illumina-plugins.jar file, 
576 07 Feb 08 martin 46 and to the same raw data types and extended property configurations files as 
576 07 Feb 08 martin 47 the Tomcat web server. If the job agents are not running from the same BASE 
576 07 Feb 08 martin 48 installation directory, you may need to copy the files to a proper location.
1142 25 Jun 09 martin 49 '''Notice: you may have to configure the JAR path manually for each job agent.'''
959 11 Feb 09 martin 50
1236 31 Aug 10 jari 51
959 11 Feb 09 martin 52 == Upgrade ==
959 11 Feb 09 martin 53
959 11 Feb 09 martin 54 The instructions below are comments how to follow the steps in installation section when upgrading an 
959 11 Feb 09 martin 55 already installed Illumina package.
959 11 Feb 09 martin 56  1. Do the step 1-3 as described in the installation instructions.
1236 31 Aug 10 jari 57  2. Then proceed with step 4. [[br]]
1236 31 Aug 10 jari 58     '''Caution:''' ''Any changes in the files on the local server must
1236 31 Aug 10 jari 59     be transferred to the new configuration-files before they are
1236 31 Aug 10 jari 60     copied.'' Copying the new files will overwrite the existing
1236 31 Aug 10 jari 61     files.
1386 06 Sep 11 nicklas 62  3. Do step 5-8 as described.
1386 06 Sep 11 nicklas 63  4. Step 9-12 is optional and only needed if the release comes with new Illumina variants that you want to create.
1386 06 Sep 11 nicklas 64  5. Done. The Illumina package is now updated. You can restart any job-agents as well.
1236 31 Aug 10 jari 65
1236 31 Aug 10 jari 66 ----------------------------------------------------------------------
1236 31 Aug 10 jari 67 {{{
1236 31 Aug 10 jari 68 Copyright (C) 2008 Jari Häkkinen, Nicklas Nordborg
1236 31 Aug 10 jari 69 Copyright (C) 2009 Jari Häkkinen, Martin Svensson
1236 31 Aug 10 jari 70 Copyright (C) 2010 Jari Häkkinen, Nicklas Nordborg
1236 31 Aug 10 jari 71
1236 31 Aug 10 jari 72 This file is part of Illumina plug-in package for BASE.
1236 31 Aug 10 jari 73 Available at http://baseplugins.thep.lu.se/
1236 31 Aug 10 jari 74 BASE main site: http://base.thep.lu.se/
1236 31 Aug 10 jari 75
1236 31 Aug 10 jari 76 This is free software; you can redistribute it and/or
1236 31 Aug 10 jari 77 modify it under the terms of the GNU General Public License
1236 31 Aug 10 jari 78 as published by the Free Software Foundation; either version 3
1236 31 Aug 10 jari 79 of the License, or (at your option) any later version.
1236 31 Aug 10 jari 80
1236 31 Aug 10 jari 81 The software is distributed in the hope that it will be useful,
1236 31 Aug 10 jari 82 but WITHOUT ANY WARRANTY; without even the implied warranty of
1236 31 Aug 10 jari 83 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
1236 31 Aug 10 jari 84 GNU General Public License for more details.
1236 31 Aug 10 jari 85
1236 31 Aug 10 jari 86 You should have received a copy of the GNU General Public License
1236 31 Aug 10 jari 87 along with BASE. If not, see <http://www.gnu.org/licenses/>.
1236 31 Aug 10 jari 88 }}}
1236 31 Aug 10 jari 89 ----------------------------------------------------------------------

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