c_cpp/etc/jellyfish/README

   1 Installation
   2 ============
   3
   4 % ./configure
   5 % make
   6 # As root:
   7 % make install
   8
   9 To install in a custom directory:
  10
  11 % ./configure --prefix=/my/dir
  12 % make
  13 % make install
  14
  15 Then make sure the following environment variables contain the correct
  16 paths:
  17
  18 PATH            -> /my/dir/bin
  19 LD_LIBRARY_PATH -> /my/dir/lib
  20 MANPATH         -> /my/dir/share/man
  21 PKG_CONFIG_PATH -> /my/dir/lib/pkgconfig
  22
  23 Only the PATH environment variables is necessary to run
  24 jellyfish. MANPATH is used by the man command. PKG_CONFIG_PATH and
  25 LD_LIBRARY_PATH are used to compile software against the jellyfish
  26 shared library.
  27
  28 Tests
  29 =====
  30
  31 To run the built-in tests, do:
  32
  33 % make check
  34
  35 All tests should pass and 1 test should be skipped (big.sh). Running
  36 'make check' will use about 50MB of disk space and will use every CPUs
  37 found on the machine. On our test machine with 32 cores, it takes a
  38 few minutes to run.
  39
  40 To tests also on large data set, do:
  41
  42 % make check BIG=1
  43
  44 WARNING: this uses >40GB of disk space and takes 30 minutes to run (20
  45 to create the data, 10 to run jellyfish).
  46
  47 Notes
  48 =====
  49
  50 * Jellyfish has been devellopped and tested on x86-64 GNU/Linux. It
  51   compiles and runs correctly the tests on MacOS X (Intel) and
  52   FreeBSD. It should be fairly easy to port on other *NIX platform
  53   with the gcc compiler, but no guarantee is made. Support for 32-bits
  54   platform has not been tested.
  55
  56 License
  57 =======
  58
  59 * The Mersenne Twister random generator is copyrighted by Agner Fog
  60   and distributed under the GPL version 3 or
  61   higher. http://www.agner.org.
  62
  63 * The Half float implementation is copyrighted by Industrial Light &
  64   Magic and is distributed under the license described in the
  65   HalfLICENSE file.
  66
  67 *   This program is free software: you can redistribute it and/or modify
  68     it under the terms of the GNU General Public License as published by
  69     the Free Software Foundation, either version 3 of the License, or
  70     (at your option) any later version.
  71
  72     This program is distributed in the hope that it will be useful,
  73     but WITHOUT ANY WARRANTY; without even the implied warranty of
  74     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  75     GNU General Public License for more details.
  76
  77     You should have received a copy of the GNU General Public License
  78     along with this program.  If not, see <http://www.gnu.org/licenses/>.