INSTALLING.txt

BIDMat is a set of Scala, Java and native code libraries. To run it, you need:

* A java runtime, version 1.7 or later.

* An Installation of the Scala language, which you can get from here: http://www.scala-lang.org/
  You need Scala 2.10.3 or later. We have tested extensively on 2.10.3 and 2.10.4.

* A 64bit Intel machine (Linux, Windows, and Mac), if you plan to use any native
  code acceleration. We have tested on Windows 7 and RedHat Enterprise Linux 6 and Mac OS X. 
  A lot of the code will still work, but that's really not the point of the library.

* To use these libraries with a CUDA GPU, you need a CUDA-enabled GPU device. The code has
  been developed for GTX 600-series, and this is the ideal platform. The code should work
  with Tesla K10 devices, which share the same GPU chip as the 680/690 which is our
  main platform. Most operations will work also with 500-series and we are working to add
  the others. 

* You need the [http://developer.nvidia.com/cuda/cuda-downloads NVIDIA CUDA driver and the
  CUDA Toolkit] from the NVIDIA website. This version is based on CUDA 5.5. 

You should just be able to run the "bidmat" script from the top-level
directory. If that doesnt work, its probably because $JAVA_HOME is not set in your
environment, because "scala" is not in your path, or because the script is allocating too
much memory - if its the latter, edit "bidmat" and change the -Xmx option to something
smaller.