|
Name |
|
Date |
Size |
#Lines |
LOC |
| .. | | 03-May-2022 | - |
| doc/ | H | 03-May-2022 | - | 648 | 634 |
| include/jellyfish/ | H | 05-Feb-2020 | - | 10,733 | 7,318 |
| jellyfish/ | H | 05-Feb-2020 | - | 2,028 | 1,543 |
| lib/ | H | 03-May-2022 | - | 5,150 | 4,052 |
| m4/ | H | 05-Feb-2020 | - | 10,433 | 9,468 |
| sub_commands/ | H | 05-Feb-2020 | - | 6,609 | 5,846 |
| swig/ | H | 05-Feb-2020 | - | 19,095 | 14,835 |
| tests/ | H | 05-Feb-2020 | - | 467 | 303 |
| unit_tests/ | H | 05-Feb-2020 | - | 33,547 | 22,295 |
| LICENSE-BSD-3-Clause | H A D | 13-Jul-2019 | 1.5 KiB | 30 | 24 |
| LICENSE-GPL-3.0 | H A D | 13-Jul-2019 | 34.3 KiB | 675 | 553 |
| Makefile.am | H A D | 05-Feb-2020 | 9.6 KiB | 231 | 179 |
| Makefile.in | H A D | 05-Feb-2020 | 172.7 KiB | 2,867 | 2,584 |
| README | H A D | 13-Jul-2019 | 2.4 KiB | 86 | 61 |
| aclocal.m4 | H A D | 23-Aug-2019 | 96.8 KiB | 2,603 | 2,437 |
| compat.sh.in | H A D | 13-Jul-2019 | 627 | 30 | 25 |
| compile | H A D | 23-Aug-2019 | 7.2 KiB | 348 | 258 |
| config.guess | H A D | 23-Aug-2019 | 43.2 KiB | 1,481 | 1,288 |
| config.h.in | H A D | 23-Aug-2019 | 5.1 KiB | 198 | 132 |
| config.rpath | H A D | 28-Mar-2018 | 14.6 KiB | 546 | 438 |
| config.sub | H A D | 23-Aug-2019 | 35.3 KiB | 1,802 | 1,661 |
| configure | H A D | 23-Aug-2019 | 654.8 KiB | 21,427 | 18,219 |
| configure.ac | H A D | 13-Jul-2019 | 6.9 KiB | 167 | 145 |
| depcomp | H A D | 23-Aug-2019 | 23 KiB | 792 | 502 |
| gtest.mk | H A D | 13-Jul-2019 | 588 | 19 | 10 |
| install-sh | H A D | 23-Aug-2019 | 14.8 KiB | 509 | 329 |
| jellyfish-2.0.pc.in | H A D | 28-Mar-2018 | 278 | 11 | 9 |
| ltmain.sh | H A D | 23-Aug-2019 | 316.8 KiB | 11,157 | 7,986 |
| missing | H A D | 23-Aug-2019 | 6.7 KiB | 216 | 143 |
| test-driver | H A D | 23-Aug-2019 | 4.5 KiB | 149 | 87 |
README
1Installation
2============
3
4% ./configure
5% make
6# As root:
7% make install
8
9To install in a custom directory:
10
11% ./configure --prefix=/my/dir
12% make
13% make install
14
15Then make sure the following environment variables contain the correct
16paths:
17
18PATH -> /my/dir/bin
19MANPATH -> /my/dir/share/man
20PKG_CONFIG_PATH -> /my/dir/lib/pkgconfig
21
22Only the PATH environment variables is necessary to run
23jellyfish. MANPATH is used by the man command. PKG_CONFIG_PATH is used
24to compile software against the jellyfish shared library.
25
26GCC requirement
27===============
28
29GCC version 4.4 or higher is required to compile Jellyfish. Most
30current Linux distribution provides a version of gcc current
31enough. On RedHat 5.x, install the packages gcc44 and gcc44-c++.
32
33To install on Mac OS X: Jellyfish 2.0 does not compile with Apple's
34Xcode GCC 4.2. Instead, the easiest thing to do is to install GCC 4.8
35using MacPorts (http://www.macports.org) using the following commands:
36
37 sudo port install gcc48
38 sudo port install gcc_select
39 sudo port select -set gcc mp-gcc48
40
41The first command installs GCC version 4.8. The third command makes
42that version of GCC the default, and the second installs a package that
43makes the third command work. After the above, you should be able to
44run './configure ; make' as normal.
45
46Tests
47=====
48
49To run the built-in tests, do:
50
51% make check
52
53All tests should pass and 1 test should be skipped (big.sh). Running
54'make check' will use about 50MB of disk space and will use every CPUs
55found on the machine. On our test machine with 32 cores, it takes a
56few minutes to run.
57
58To tests also on large data set, do:
59
60% make check BIG=1
61
62WARNING: this uses >40GB of disk space and takes 30 minutes to run (20
63to create the data, 10 to run jellyfish).
64
65Notes
66=====
67
68* Jellyfish has been developed and tested on x86-64 GNU/Linux. It
69 compiles and runs correctly the tests on MacOS X (Intel) and
70 FreeBSD. It should be fairly easy to port on other *NIX platform
71 with the gcc compiler, but no guarantee is made. Support for 32-bits
72 platform has not been tested.
73
74License
75=======
76
77* The Mersenne Twister random generator is copyrighted by Agner Fog
78 and distributed under the GPL version 3 or
79 higher. http://www.agner.org.
80
81* The Half float implementation is copyrighted by Industrial Light &
82 Magic and is distributed under the license described in the
83 HalfLICENSE file.
84
85* This software is dual licenced. See LICENSE file.
86