|
0
|
1 % Xenome README
|
|
|
2 % September, 2012
|
|
|
3
|
|
|
4 Xenome is a tool for classifying reads from xenograft sources.
|
|
|
5
|
|
|
6 REQUIREMENTS
|
|
|
7 ===========
|
|
|
8
|
|
|
9 Xenome should run on any standard 64 bit Linux environment, with as little as
|
|
|
10 2 GB of free RAM. For best performance, when classifying reads according to a
|
|
|
11 mouse/human reference (k=25), we recommend using a machine with 16 GB of RAM.
|
|
|
12
|
|
|
13 INSTALLATION
|
|
|
14 ===========
|
|
|
15
|
|
|
16 The Xenome program and related files (including this README.txt) will be
|
|
|
17 extracted to a directory called xenome-*version* where *version* is the version
|
|
|
18 number for the distribution. For example, for version 0.1.1 this will be the
|
|
|
19 directory xenome-0.1.1.
|
|
|
20
|
|
|
21 The following files should appear in this directory:
|
|
|
22
|
|
|
23 ***
|
|
|
24
|
|
|
25 ---------------------------------------------------------------------------
|
|
|
26 File Name Description
|
|
|
27 ----------- -------------
|
|
|
28 xenome The Xenome program.
|
|
|
29
|
|
|
30 xenome.pdf The Xenome manual in pdf format.
|
|
|
31
|
|
|
32 xenome.1 The Xenome unix manpage. To view use :
|
|
|
33 man ./xenome.1
|
|
|
34
|
|
|
35 license.txt The license for Xenome.
|
|
|
36
|
|
|
37 README.txt This readme file.
|
|
|
38
|
|
|
39 ---------------------------------------------------------------------------
|
|
|
40
|
|
|
41 ***
|
|
|
42
|
|
|
43 Please refer to the Xenome manual for further details and for examples.
|
|
|
44
|
|
|
45 This software is distributed under the included license.
|
