= Rave Installation =

== Dependencies ==

The following software is needed to build rave:

 * (Gnu) C++ compiler
 * boost
 * clhep2 (should work with clhep1, also, though).

In the future, root's TMVA analysis toolkit can optionally be used by rave for 
flavor-tagging (along with non-TMVA-dependent learning algorithms).

== Download ==
Note that various packages and tarballs exist, see the download section:
http://www.hepforge.org/downloads/rave

If you download from the svn repository, the following command would do the job:
{{{
  svn co http://svn.hepforge.org/rave/trunk
}}}

You will need to {{{sh bootstrap}}} if you compile from the svn repository.

If you download the zipped svn archive from the web, you'll have to add
the 'svn externals' manually:
{{{
  cd m4 && svn co http://svn.hepforge.org/cedar/trunk/pub/autotools/ cedar
}}}

== Linux/Unix ==

Rave is fully autotooled. '''configure; make; make install''' are your friends.
Package builders may want to call '''bootstrap''' before using
''configure'' and ''make''.
Also check '''configure --help''' for special configuration options.

== Java ==

In order to be able to build the java bindings,
the following applications need to be installed on the system:

 * ''javac'' (''gcj'' will soon be added as another option)
 * ''java''
 * ''jar'' or ''fastjar''
 * ''swig''

If these are all found, then building the java bindings
will be enabled per default.
Disabling the bindings can also be specified explicitly:
{{{
./configure --disable-java
}}}

It might be necessary to tell ''configure'' where to look for the java 
binaries and libraries:
{{{
./configure --with-java-home=<JAVAHOME>
}}}


Note that with rave < 0.2.2, for java to work, it is necessary to turn off optimisation, e.g.
{{{
configure CXXFLAGS="-g" 
}}}
This is fixed in the subversion head.

== Windows ==

Windows dlls do not yet work, mainly because the clhep needed to be patched, and this
patch is not yet "public".
But as soon as it is, Rave "native" windows dlls can be compiled both under cygwin,
(using the mingw compiler), as well as using the cross-mingw compiler for e.g. Linux.
Because windows is such a peculiar platform, one has to do "make dlls" _after_ having done
"make". Apart from this, everything else should be the same.
Install the following packages (incomplete list): boost, boost-devel, gcc-g++, gcc-java, gcc-mingw-java, pkg-config, swig, automake

Links:
 * cygwin: http://www.cygwin.com/
 * clhep: http://proj-clhep.web.cern.ch/proj-clhep/DISTRIBUTION/clhep.html
 * swig: http://www.swig.org/download.html