Gk-arrays: Querying large read collections in main memory: a versatile data structure.
Installation
The installation will create you between one and four versions of a test executable (called
buildTables
) and a library
that could be used in any of your programs.
You can have a 32-bit and 64-bit library as well as a fixed and a variable-length read library.
Hence depending on the options you specify, you may have between one and four versions of the library.
Installation from the source code
- Unpack the archive
- Enter the directory libGkArrays-version-number
- Type
./configure
- If everything went fine, run
make
- To install the library on your machine, type
make install
as an administrator
You can specify parameters to the 'configure' script.
By default,
make
will create a 32-bit implementation of the Gk-arrays for variable-length reads.
If you have lots of reads, then you need the 64-bit implementation.
If your reads all have the same length, then you should use the fixed-length read implementation which runs much faster.
For both cases, there exists an option in the
configure
script:
- 64-bit implementation:
--enable-64bits
- fixed-length reads:
--enable-fixed-read-length
If you specify both options, you will end with four versions of the library:
- 32-bit and fixed-length (
libGkArrays-fixed
);
- 32-bit and variable-length (
libGkArrays
);
- 64-bit and fixed-length (
libGkArrays64-fixed
);
- 64-bit and variable-length (
libGkArrays64
).
Installation from the deb
package
You just need to install the package using a dedicated program on your distribution or by typing
dpkg -i package-name
.
This will install all the four versions of the library (32 and 64 bits, fixed and variable).
Using Gk-arrays in your code
Inside the archive, you will find under the
doc
directory a documentation on how to use the Gk-arrays in your code with a simple example.
A full documentation of the library is available
online or as a downloadable
PDF.