source: extensions/net.sf.basedb.mev/trunk/README @ 1444

Last change on this file since 1444 was 1442, checked in by Nicklas Nordborg, 10 years ago

Preparing 'MeV Launcher 1.8' release.

  • Property svn:mime-type set to text/x-trac-wiki
File size: 3.5 KB
RevLine 
[666]1== Requirements ==
2
[1383]3 1. BASE 3.0 or later.
[666]4 
5== Introduction ==
6
7This package is an extension package to BASE that installs an action that
8opens TIGR MultiExperiment Viewer (MEV) as a Java webstart application and
9automatically imports data from the currently selected bioassay set. This
[1442]10extension uses the standard MEV 4.7.3 distribution that has been
[976]11Java Webstart enabled. For more information:
[666]12
13 * The homepage for this extension:
14   http://baseplugins.thep.lu.se/wiki/net.sf.basedb.mev
15 * The official MEV homepage: http://www.tm4.org/mev.html
16
17== Installation ==
18
[690]19 1. Download the mev-launcher-*.tar.gz file.
[666]20 2. Unpack the downloaded file to a directory of your choice.
[1383]21 3. Copy the mev-launcher.jar file to your BASE plug-ins directory. Look in
[1395]22   your 'base.config' file if you don't know where this is.
[1442]23 4. Go to 'Administrate->Plug-ins & Extensions->Overview' page.
[1383]24 5. Run the installation wizard and select to install 'mev-launcher.jar'.
[1159]25 6. Run the 'MeV package installer' plug-in. Find this plug-in on the
26    'Administrate -> Plugins -> Definitions' page, click on it, and then
27    on the 'Run plugin' button. Complete the installation wizard. This will
28    install required items, eg. data file types, that are required by MeV.
29 7. The 'MeV CGH exporter' plug-in requires that an admin configures the
30    reporter annotations that corresponds to the CGH file columns. Go to the
[1082]31    'Administrate -> Plugins -> Definitions' page and click on the
[1099]32    'MeV CGH exporter' plug-in. Click on 'New configuration...' and
[1082]33    enter a name and optionally a description. Then, click on 'Save and
34    configure' and select the corresponding reporter annotation columns
35    for the four CGH file columns (chromosome, start, end and description).
[1159]36    Finish the configuration.
[1395]37 8. The TDMS and CGH exporter plug-ins are shared to everyone by default. If
38    that isn't desired, you may want to change this at this stage.
[1182]39 9. Done.
[1068]40 
41 The MeV Launcher appears as an action in the "Tools" column when
42 viewing bioassay sets of an experiment. Some (per-user) options can be
43 specified by opening the 'Extensions -> MeV Launcher options' menu.
[666]44
[1068]45The MeV export plug-ins appears in the 'Export' dialog when viewing
46bioassay sets of an experiment.
47
[666]48== Known issues ==
49
[1190]50MeV modules that use R will not work. See the "Known issues" section
51at http://www.tm4.org/mev/features/releases for more information.
[666]52
53== Compiling ==
54
55To compile this package you also need:
56 
[1442]57 1. Ant 1.8
[666]58 2. Java 1.6
59
60Follow these instructions:
61
62 1. Download the source code from the subversion repository. See
63    http://baseplugins.thep.lu.se/wiki/net.sf.basedb.mev for instructions.
64 
[1191]65 2. Type `ant download-lib` to automatically download the BASE core JAR files that
[690]66    are neeed for compilation. You can also do this manually by copying the
[1395]67    base-core-3.0.0.jar, base-webclient-3.0.0.jar, base-coreplugins-3.0.0.jar and
68    base-webservices-client-3.0.0.jar from the BASE installation directory
69    (<basedir>/www/WEB-INF/lib/) to the ./lib/compile directory.
[666]70
71 3. Type 'ant' to compile the code and generate the 'mev-launcher.jar' file
72    in the project directory.
73
74 4. Use 'ant package' to create a downloadable tar.gz package.
[690]75 
76Tip: If you need different values for any of the properties defined in
77the 'build.xml' file, create a file named 'build.properties' and set
78the values there.
[976]79
80Note! If upgrading MeV to a new version, the new JAR files needs to
81be signed. See `./jarsign/readme.txt` for more information.
82
83
84== Contributions ==
85
86 * David Waring, for helping out with MeV 4.3 integration.
Note: See TracBrowser for help on using the repository browser.