← Back to branch summary

~ubuntu-branches/debian/jessie/arb/jessie

« back to all changes in this revision

Viewing changes to arb_README.txt

  • Committer: Package Import Robot
  • Author(s): Elmar Pruesse, Andreas Tille, Elmar Pruesse
  • Date: 2014-09-02 15:15:06 UTC
  • mfrom: (1.1.6)
  • Revision ID: package-import@ubuntu.com-20140902151506-jihq58b3iz342wif
Tags: 6.0.2-1
http://bugs.debian.org/741890
http://bugs.debian.org/757497
[ Andreas Tille ]
* New upstream version
  Closes: #741890
* debian/upstream -> debian/upstream/metadata
* debian/control:
   - Build-Depends: added libglib2.0-dev
   - Depends: added mafft, mrbayes
* debian/rules
   - Add explicite --remove-section=.comment option to manual strip call
* cme fix dpkg-control
* arb-common.dirs: Do not create unneeded lintian dir
* Add turkish debconf translation (thanks for the patch to Mert Dirik
  <mertdirik@gmail.com>)
  Closes: #757497

[ Elmar Pruesse ]
* patches removed:
   - 10_config.makefiles.patch,
     80_no_GL.patch
       removed in favor of creating file from config.makefile.template via 
       sed in debian/control
   - 20_Makefile_main.patch
       merged upstream
   - 21_Makefiles.patch
       no longer needed
   - 30_tmpfile_CVE-2008-5378.patch: 
       merged upstream
   - 50_fix_gcc-4.8.patch:
       merged upstream
   - 40_add_libGLU.patch:
       libGLU not needed for arb_ntree)
   - 60_use_debian_packaged_raxml.patch:
       merged upstream
   - 70_hardening.patch
       merged upstream
   - 72_add_math_lib_to_linker.patch
       does not appear to be needed
* patches added:
   - 10_upstream_r12793__show_db_load_progress:
       backported patch showing progress while ARB is loading a database
       (needed as indicator/splash screen while ARB is launching)
   - 20_upstream_r12794__socket_permissions:
       backported security fix
   - 30_upstream_r12814__desktop_keywords:
       backported add keywords to desktop (fixes lintian warning)
   - 40_upstream_r12815__lintian_spelling:
       backported fix for lintian reported spelling errors
   - 50_private_nameservers
       change configuration to put nameservers into users home dirs
       (avoids need for shared writeable directory)
   - 60_use_debian_phyml
       use phyml from debian package for both interfaces in ARB
* debian/rules:
   - create config.makefile from override_dh_configure target
   - use "make tarfile" in override_dh_install
   - remove extra cleaning not needed for ARB 6
   - use "dh_install --list-missing" to avoid missing files
   - added override_dh_fixperms target
* debian/control:
   - added libarb-dev package
   - Depends: added phyml, xdg-utils
   - Suggests: removed phyml
   - fix lintian duplicate-short-description (new descriptions)
* debian/*.install:
   - "unrolled" confusing globbing to select files
   - pick files from debian/tmp
   - moved all config files to /etc/arb
* debian/arb-common.templates: updated
* scripts:
   - removed arb-add-pt-server
   - launch-wrapper: 
     - only add demo.arb to newly created $ARBUSERDATA
     - pass commandline arguments through bin/arb wrapper
   - preinst: removing old PT server index files on upgrade from 5.5*
   - postinst: set setgid on shared PT dir
* rewrote arb.1 manfile
* added file icon for ARB databases
* using upstream arb_tcp.dat

Show diffs side-by-side

added added

removed removed

Lines of Context:
arb_README.txt
1
1
 
2
 
Welcome to the 'ARB' Sequence Database Tools
 
2
Welcome to the ARB 6 Sequence Analysis Suite 
3
3
 
4
4
 
5
5
System Requirements
6
6
------------------- 
7
7
 
8
 
 
9
 
        ARB is currently developed on Linux PCs only.
10
 
 
11
 
        Compiling ARB using the gcc compiler (3.x and 4.x series)
12
 
        as well works on Mac OSX and Sun OS - but we do not publish or support
13
 
        these versions.
14
 
 
15
 
 
16
 
        Hardware Requirements (Linux):
17
 
 
18
 
                                Good                    We use
19
 
        Real memory :           1 Gb                    4 Gb    
20
 
        Free discspace :        1 Gb                    more    
21
 
        Computer speed :        2 GHz Cpu               2 GHz Dual Cpu
22
 
                                
23
 
 
24
 
        Note : Memory is more important than a fast processor!
25
 
 
26
 
 
27
 
Files needed to install ARB
28
 
---------------------------
29
 
 
30
 
        File                    
31
 
 
32
 
        'arb_install.sh'        // install script
33
 
        'arb.*.tgz'             // ARB program
34
 
 
35
 
 
36
 
        Available ARB versions:
37
 
 
38
 
        'arb.32.*.tgz'          // 32 bit versions
39
 
        'arb.64.*.tgz'          // 64 bit versions
40
 
 
41
 
        'arb.*.OPENGL.tgz'      // OPENGL version (contains RNA3D, a 3D-molecule-viewer)
42
 
 
43
 
 
44
 
        Choose a 32-bit-version, if your system is 32-bit,
45
 
        choose a 64-bit-version, if your system is 64-bit.
46
 
 
47
 
        You need only ONE of the available 'arb.*.tgz'!
48
 
 
49
 
 
50
 
Install/Update ARB
51
 
------------------
52
 
 
53
 
        ARB consists of more than 1200 files which are installed into a single
54
 
        directory. Creating this directory, copying all data into it, and setting
55
 
        the permissions correctly is done by the installation script
56
 
 
57
 
                'arb_install.sh'
58
 
 
59
 
        Goto the directory, where the files
60
 
 
61
 
                'arb_install.sh'                // install script
62
 
                'arb_README.txt'                // this file
63
 
                'arb.*.tgz'                     // your chosen ARB version
64
 
 
65
 
 
66
 
        are located and type
67
 
 
68
 
                '/bin/sh arb_install.sh'
69
 
 
70
 
        Answer all questions asked by the script.
71
 
 
72
 
        Notes:- The script will ask about a pt_server directory. This is a
73
 
                directory where arb will store big index files.
74
 
                You should enter a different path as you do not want to
75
 
                recreate those files after an ARB update.
76
 
              - Normally pressing enter will be a good choice.
77
 
              - You can rerun the script many times, it can be used to
78
 
                change an existing installation.
79
 
 
80
 
        Change your .cshrc/.profile files:
81
 
 
82
 
                Set the environment variable ARBHOME
83
 
                to the ARB installation directory
84
 
                Append   $ARBHOME/bin   to your PATH
85
 
 
86
 
        reread it,      (logout+login )
87
 
 
88
 
        goto a directory with a demo database 'eg demo.arb'
89
 
        and start 'ARB' with
90
 
 
91
 
                        'arb'
 
8
  Minimal (demo.arb):
 
9
      Operating System: Linux or OSX
 
10
      CPU:              any
 
11
      Memory:           1 GB
 
12
      Hard drive:       200 MB
 
13
 
 
14
  Recommended (SILVA SSU NR99 r115):
 
15
      Operating System: Linux (Ubuntu 12.04 or newer) 
 
16
                        OSX (10.5.8 or newer)
 
17
      CPU:              >2 GHz multi-core
 
18
      Memory:           16 GB (or more!)
 
19
      Hard drive:       10 GB
 
20
 
 
21
  Notes:
 
22
  The resources required for ARB to run smoothly depend on the size of the
 
23
  database(s) you intend to work with. Large databases, especially the SSU
 
24
  databases provided by the SILVA project, require large amounts of fast
 
25
  memory.
 
26
 
 
27
 
 
28
Installation using Package Managers:
 
29
----------------------------------
 
30
 
 
31
  OSX:
 
32
    The recommended approach is to install MacPorts (macports.org) and use
 
33
    the ports command to install arb: "sudo port install arb"
 
34
 
 
35
  Debian Linux:
 
36
    ARB is available in Debian Testing in section "non-free". Install ARB
 
37
    using "apt-get install arb" or your preferred GUI front-end to apt-get. 
 
38
 
 
39
 
 
40
Installation from Pre-Compiled Binaries:
 
41
----------------------------------------
 
42
 
 
43
  1) Download "arb_install.sh" and the arb-*.tgz matching your distribution
 
44
     from http://download.arb-home.de/release/latest/
 
45
 
 
46
     Files:
 
47
     arb-*.centos5-amd64.tgz
 
48
     arb-*.centos6-amd64.tgz
 
49
     arb-*.osx.tgz
 
50
     arb-*.ubuntu1004-amd64.tgz
 
51
     arb-*.ubuntu1204-amd64.tgz
 
52
     arb-*.ubuntu1304-amd64.tgz
 
53
 
 
54
     (where '*' stands for the most recent version number, e.g. '6.0.1')
 
55
 
 
56
     If your distribution is neither Ubuntu nor Centos, try Centos. 
 
57
     If your distributions version is not among the above, try the next older
 
58
     release (e.g. 12.04 if you have 12.10).
 
59
 
 
60
     Notes:
 
61
        * All versions are compiled without OPENGL.
 
62
          (if you rely on OPENGL features, either stick with arb_5.5 or 
 
63
          compile arb from source)
 
64
        * Debian users need to pick Centos (due to fun with [e]glibc) or better
 
65
          use the package from non-free.
 
66
         
 
67
  2a) Install using "arb_install.sh"
 
68
 
 
69
      Open a terminal, change to the directory where you have saved the
 
70
      files needed for installation:
 
71
 
 
72
         'arb_install.sh'                // install script
 
73
         'arb_README.txt'                // this file
 
74
         'arb-*.tgz'                     // your chosen ARB version
 
75
 
 
76
      and type
 
77
 
 
78
          sh arb_install.sh
 
79
 
 
80
      (to install arb for all users call the script as root or via sudo)
 
81
 
 
82
      Answer all questions asked by the script.
 
83
 
 
84
      Notes:
 
85
         - The script will ask about a pt_server directory. This is a
 
86
           directory where arb will store big index files.
 
87
           You should enter a different path as you do not want to
 
88
           recreate those files after an ARB update.
 
89
         - Normally pressing enter will be a good choice.
 
90
         - You can rerun the script many times, it can be used to
 
91
            change an existing installation.
 
92
 
 
93
      Change your ".cshrc" or ".profile" files:
 
94
 
 
95
      Set the environment variable ARBHOME to the ARB installation directory
 
96
      Append   $ARBHOME/bin   to your PATH.
 
97
      Re-Login to load the changed environment.
 
98
 
 
99
      Go to a directory with a demo database eg 'demo.arb'and start 'ARB' with
 
100
        
 
101
         arb
 
102
 
 
103
  2b) Install manually
 
104
 
 
105
      i)   Create a folder where you want ARB to reside. E.g:
 
106
      
 
107
         mkdir ~/arb-6.0
 
108
 
 
109
      ii)  Unpack ARB into this folder. E.g.
 
110
 
 
111
         tar -C ~/arb-6.0 -xzf ~/Downloads/arb-6.0.1.ubuntu1304-amd64.tgz
 
112
 
 
113
      iii) Install library dependencies. 
 
114
 
 
115
      (If you already have an ARB installation and just want to install another
 
116
      version, you can skip this step.)
 
117
 
 
118
      ARB needs:
 
119
         gnuplot, gv, openmotif, xfig, transfig, xterm, libtiff, libX11, libXaw, 
 
120
         libXext, libxml2, libXpm, libXt, lynx, time, libxslt, glib2, readline
 
121
 
 
122
      On Centos, dependencies should be satisfied by running:
 
123
        
 
124
         sudo yum install gnuplot openmotif xfig transfig xterm libXpm \
 
125
            libtiff libX11 libXaw libXext libxml2 libXpml libXt lynx \
 
126
            time libxslt readline glib2
 
127
 
 
128
      On Ubuntu 13.04, use:
 
129
 
 
130
         sudo apt-get install gnuplot gv libmotif3 xfig transfig \
 
131
           xterm libxpm4 libtiff4 libx11-6 libxaw7 libxext6 libxml2-utils \
 
132
           libxt6 lynx libreadline6
 
133
         
 
134
      If any of the packages is not available on your system, it might just
 
135
      have a slightly differing name. Try using  "yum search" or 
 
136
      "apt-cache search" to  search for packages matching the base name 
 
137
      (e.g. "yum search libxpm") and pick the one that's available. The only
 
138
      known issue is that you must not use "lesstif" instead of 
 
139
      motif/openmotif (if you do, the interface will look broken).
 
140
 
 
141
      You can now run ARB simply by entering "./bin/arb" from the folder
 
142
      where you installed ARB. For convenience, put a symlink to the file
 
143
      into any folder that is in your PATH so that you can just type "arb"
 
144
      to run it.
 
145
 
 
146
 
 
147
Compiling ARB from source
 
148
-------------------------
 
149
 
 
150
  * See arb_INSTALL.txt for information about how to compile
 
151
    arb from source.
92
152
 
93
153
 
94
154
Additional information
95
155
----------------------
96
156
 
97
 
        * See arb_INSTALL.txt for additional software needed and/or useful
98
 
          together with ARB.
 
157
  * See arb_INSTALL.txt for additional software needed and/or useful
 
158
   together with ARB.
99
159
 
100
160
 
101
161
PT_server
102
162
---------
103
163
 
104
 
        To Install 'ARB' you have to know that some modules use a so
105
 
        called 'pt_server' (prefix tree server).
106
 
 
107
 
        ARB needs a writeable directory to store the pt_server files.
108
 
        Those files are needed for fast database search
109
 
        (by probe_design, probe_match and the automatic aligner)
110
 
        and need a lot of disc space (up to several 100 mega bytes,
111
 
        e.g. 4000 16S RNA sequences require about 40 MB).
112
 
        This files are not created now. They can be build by any user via
113
 
                <ARB_NTREE/Probes/PT_SERVER admin/Build server>
114
 
        You may define a special directory as the pt_server files location.
115
 
        This prevents any loss of data installing a new version of
116
 
        ARB.
117
 
        To minimize the use of ressources in a workstation cluster
118
 
        only one pt_server for each database is started on a user defined
119
 
        host. The first user starts the pt_server, and all other users
120
 
        can connect to it.
121
 
 
122
 
 
123
 
What you should know: Swap
124
 
--------------------------
125
 
 
126
 
        Arb needs a lot of virtual memory
127
 
        (about 50 Mbyte for 5000 Sequences, Length = 3000).
128
 
        You can find out about installed swap space by typing:
129
 
 
130
 
                Linux                   'top'
131
 
                SunOS 1.x:              'pstat -s'
132
 
                System V / SGI          'swap -s'
133
 
                OSF                     'swapon -sv'
134
 
 
135
 
        Call your system administrator or local guru to increase your
136
 
        swap. (If you don't have such a nice person, try to read the
137
 
        man pages: 'man -k swap')
 
164
  To Install 'ARB' you have to know that some modules use a so
 
165
  called 'pt_server' (prefix tree server).
 
166
 
 
167
  ARB needs a writeable directory to store the pt_server files.
 
168
  Those files are needed for fast database search
 
169
  (by probe_design, probe_match and the automatic aligner)
 
170
  and need a lot of disc space (up to several 100 mega bytes,
 
171
  e.g. 4000 16S RNA sequences require about 40 MB).
 
172
  This files are not created now. They can be build by any user via
 
173
      <ARB_NTREE/Probes/PT_SERVER admin/Build server>
 
174
  You may define a special directory as the pt_server files location.
 
175
  This prevents any loss of data installing a new version of
 
176
  ARB.
 
177
  To minimize the use of ressources in a workstation cluster
 
178
  only one pt_server for each database is started on a user defined
 
179
  host. The first user starts the pt_server, and all other users
 
180
  can connect to it.
138
181
 
139
182
 
140
183
The Database
141
184
------------
142
185
 
143
 
        In the current release a small dataset (demo.arb) is provided.
144
 
        This database contains a selection of artificial and real-life
145
 
        sequences.
 
186
  In the current release a small dataset (demo.arb) is provided.
 
187
  This database contains a selection of artificial and real-life
 
188
  sequences.
146
189
 
147
 
        The intention of providing this small dataset first is to give
148
 
        you the opportunity to get familiar with the program and to
149
 
        test the performance of your computer system as well as the
150
 
        stability of ARB on your system.
 
190
  The intention of providing this small dataset first is to give
 
191
  you the opportunity to get familiar with the program and to
 
192
  test the performance of your computer system as well as the
 
193
  stability of ARB on your system.
151
194
 
152
195
 
153
196
Bugs
154
197
----
155
198
 
156
 
        ARB is running properly and stably on our systems. However, it
157
 
        may be that there are bugs never detected by us or never
158
 
        appearing on our systems. Please don't hesitate to inform us
159
 
        about any bugs. A detailed description of the steps performed
160
 
        before the problem was evident and of the number and types of
161
 
        modules running at the same time would be extremely helpful to
162
 
        our computer scientists.
 
199
  ARB is running properly and stably on our systems. However, it
 
200
  may be that there are bugs never detected by us or never
 
201
  appearing on our systems. Please don't hesitate to inform us
 
202
  about any bugs. A detailed description of the steps performed
 
203
  before the problem was evident and of the number and types of
 
204
  modules running at the same time would be extremely helpful to
 
205
  our computer scientists.
163
206
 
164
 
        Please report bugs into our bug tracker at
165
 
               http://bugs.arb-home.de/
 
207
  Please report bugs into our bug tracker at
 
208
         http://bugs.arb-home.de/
166
209
 
167
210
 
168
211
Support
169
212
-------
170
213
 
171
 
        Please send any comments, bug reports or questions to
 
214
  Please send any comments, bug reports or questions to
172
215
 
173
 
                arb@arb-home.de
 
216
         arb@arb-home.de
174
217
 
175
218
 
176
219
Copyright Notice
177
220
----------------
178
221
 
179
 
        Please see the file
180
 
 
181
 
               arb_LICENSE.txt
182
 
 
183
 
        in the ARB installation directory.
 
222
   Please see the file
 
223
 
 
224
         arb_LICENSE.txt
 
225
 
 
226
  in the ARB installation directory.
184
227
 
185
228
 
186
229
Disclaimer
187
230
----------
188
231
 
189
 
        THE AUTHORS OF ARB GIVE NO WARRANTIES, EXPRESSED OR IMPLIED
190
 
        FOR THE SOFTWARE AND DOCUMENTATION PROVIDED, INCLUDING, BUT
191
 
        NOT LIMITED TO WARRANTY OF MERCHANTABILITY AND WARRANTY OF
192
 
        FITNESS FOR A PARTICULAR PURPOSE.
 
232
  THE AUTHORS OF ARB GIVE NO WARRANTIES, EXPRESSED OR IMPLIED
 
233
  FOR THE SOFTWARE AND DOCUMENTATION PROVIDED, INCLUDING, BUT
 
234
  NOT LIMITED TO WARRANTY OF MERCHANTABILITY AND WARRANTY OF
 
235
  FITNESS FOR A PARTICULAR PURPOSE.
193
236
 
194
237
 
195
238
Have fun!