JWS-116 Added the Sphinx generated documentation pages to website/docs.
[jabaws.git] / website / docs / _sources / advanced.rst.txt
1 Advanced Usage
2 ==============
3
4 JABAWS web services are WS-I basic profile compliant, which means they can be accessed using any programming language or system that can utilize standard SOAP web services. The Web Service Definition Language (WSDL) for each service is published on the JABAWS home page, and you can use this to automatically generate service bindings for your program. If you use Java you may wish to use our client package to access JABAWS. This package is based on the autogenerated source code produced by wsimport, which is the Java tool for creating web service bindings. In addition, this offers some additional methods that simplify working with JABAWS. For more information please refer to the data model javadoc.
5
6
7 ------------
8
9 .. _jabaws_wsdl:
10
11 Valid WSDL
12 ----------
13
14 **Multiple sequence alignment services**
15
16 * ClustalOWS - http://www.compbio.dundee.ac.uk/jabaws/ClustalOWS?wsdl
17 * ClustalWS - http://www.compbio.dundee.ac.uk/jabaws/ClustalWS?wsdl
18 * MuscleWS - http://www.compbio.dundee.ac.uk/jabaws/MuscleWS?wsdl
19 * MafftWS - http://www.compbio.dundee.ac.uk/jabaws/MafftWS?wsdl
20 * TcoffeeWS - http://www.compbio.dundee.ac.uk/jabaws/TcoffeeWS?wsdl
21 * ProbconsWS - http://www.compbio.dundee.ac.uk/jabaws/ProbconsWS?wsdl
22 * MSAprobsWS - http://www.compbio.dundee.ac.uk/jabaws/MSAprobsWS?wsdl
23 * GLprobsWS - http://www.compbio.dundee.ac.uk/jabaws/GLprobsWS?wsdl
24
25 **Protein disorder prediction services**
26
27 * IUPredWS - http://www.compbio.dundee.ac.uk/jabaws/IUPredWS?wsdl
28 * GlobPlotWS - http://www.compbio.dundee.ac.uk/jabaws/GlobPlotWS?wsdl
29 * DisemblWS - http://www.compbio.dundee.ac.uk/jabaws/DisemblWS?wsdl
30 * JronnWS - http://www.compbio.dundee.ac.uk/jabaws/JronnWS?wsdl
31
32 **Amino acid conservation service**
33
34 * AAConWS - http://www.compbio.dundee.ac.uk/jabaws/AAConWS?wsdl
35
36 **RNA Secondary Structure Prediction**
37
38 * RNAalifoldWS - http://www.compbio.dundee.ac.uk/jabaws/RNAalifoldWS?wsdl
39
40
41 Please replace http://www.compbio.dundee.ac.uk/ with your JABAWS instance host name, and jabaws with your JABAWS context name to access your local version of JABAWS web services. For example http://localhost:8080/jabaws would be a valid URL for the default Apache-Tomcat installation and jabaws.war file deployment.
42
43
44 ------------
45
46 .. _jabaws_config:
47
48 JABAWS Configuration
49 --------------------
50
51 There are three parts of the system you can configure. The local and the cluster engines, and the paths to the individual executables for each engine. These settings are stored in configuration files within the web application directory (for an overview, then take a look at the `war file content table`_).
52
53 Initially, JABAWS is configured with only the local engine enabled, with job output written to directory called "jobsout" within the web application itself. This means that JABAWS will work out of the box, but may not be suitable for serving a whole lab or a university.
54
55
56 ------------
57
58 .. _jabaws_config_le:
59
60 Local Engine Configuration
61 ~~~~~~~~~~~~~~~~~~~~~~~~~~
62
63 The Local execution engine configuration is defined in the properties file ``conf/Engine.local.properties``. The supported configuration settings are:
64
65 ``engine.local.enable=true`` -  enable or disable local engine, valid values true | false
66
67 ``local.tmp.directory=D:\\clusterengine\\testoutput`` - a directory to use for temporary files storage, optional, defaults to java temporary directory
68
69 ``engine.local.thread.number=4`` - Number of threads for tasks execution (valid values between 1 and 2x cpu. Where x is a number of cores available in the system). Optional defaults to the number of cores for core number <=4 and number of cores-1 for greater core numbers.
70
71 If the local engine going to be heavily loaded (which is often the case if you do not have a cluster) it is a good idea to increase the amount of memory available for the web application server. If you are using Apache-Tomcat, then you can define its memory settings in the JAVA_OPTS environment variable. To specify which JVM to use for Apache-Tomcat, put the full path to the JRE installation in the JAVA_HOME environment variable. (We would recommend using Sun Java Virtual Machine (JVM) in preference to Open JDK). Below is an example of code which can be added to ``<tomcat_dir>/bin/setenv.sh`` script to define which JVM to use and a memory settings for Tomcat server. Tomcat server startup script (``catalina.sh``) will execute ``setenv.sh`` on each server start automatically.
72
73 .. code:: bash
74
75     export JAVA_HOME=/homes/ws-dev2/jdk1.6.0_17/
76     export JAVA_OPTS="-server -Xincgc -Xms512m -Xmx1024m"
77
78
79 ------------
80
81 .. _jabaws_config_ce:
82
83 Cluster Engine Configuration
84 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
85
86 Supported configuration settings:
87
88 ``engine.cluster.enable=true`` - enable or disable local engine true | false, defaults to false
89
90 ``cluster.tmp.directory=/homes/clustengine/testoutput`` - a directory to use for temporary files storage. The value must be an absolute path to the temporary directory. This is required. The value must be different from what is defined for local engine. This directory must be accessible from all cluster nodes.
91
92 For the cluster engine to work, the SGE_ROOT and LD_LIBRARY_PATH environment variables have to be defined. They tell the cluster engine where to find DRMAA libraries. These variables should be defined when the web application server starts up, e.g.
93
94 .. code:: bash
95
96     SGE_ROOT=/gridware/sge
97     LD_LIBRARY_PATH=/gridware/sge/lib/lx24-amd64
98
99 Finally, do not forget to configure executables for the cluster execution, they may be the same as for the local execution but may be different. Please refer to the executable configuration section for further details.
100
101
102 ------------
103
104 .. _jabaws_config_ec:
105
106 Executable Configuration
107 ~~~~~~~~~~~~~~~~~~~~~~~~
108
109 All the executable programs are configured in conf/Executable.properties file. Each executable is configured with a number of options. They are:
110
111 .. code:: bash
112
113     local.X.bin.windows=<path to executable under windows system, optional>
114     local.X.bin=<path to the executable under non-windows system, optional>
115     cluster.X.bin=<path to the executable on the cluster, all cluster nodes must see it, optional>
116     X.bin.env=<semicolon separated list of environment variables for executable, use hash symbol as name value separator, optional>
117     X.--aamatrix.path=<path to the directory containing substitution matrices, optional>
118     X.presets.file=<path to the preset configuration file, optional>
119     X.parameters.file=<path to the parameters configuration file, optional>
120     X.limits.file=<path to the limits configuration file, optional>
121     X.cluster.settings=<list of the cluster specific options, optional>
122
123 Where X any of the bioinformatics tools available (e.g. clustalw, muscle, mafft, probcons, t-coffee, etc.).
124
125 Default JABAWS configuration includes path to local executables to be run by the local engine only, all cluster related settings are commented out, but they are there for you as examples. Cluster engine is disabled by default. To configure executable for cluster execution uncomment the X.cluster settings and change them appropriately.
126
127 By default limits are set well in excess of what you may want to offer to the users outside your lab, to make sure that the tasks are never rejected. The default limit is 100000 sequences of 100000 letters on average for all of the JABA web services. You can adjust the limits according to your needs by editing ``conf/settings/<X>Limit.xml`` files.
128 After you have completed the editing your configuration may look like this:
129
130 .. code:: bash
131
132     local.mafft.bin=binaries/mafft
133     cluster.mafft.bin=/homes/cengine/mafft
134     mafft.bin.env=MAFFT_BINARIES#/homes/cengine/mafft;FASTA_4_MAFFT#/bin/fasta34;
135     mafft.--aamatrix.path=binaries/matrices
136     mafft.presets.file=conf/settings/MafftPresets.xml
137     mafft.parameters.file=conf/settings/MafftParameters.xml
138     mafft.limits.file=conf/settings/MafftLimits.xml
139     mafft.cluster.settings=-q bigmem.q -l h_cpu=24:00:00 -l h_vmem=6000M -l ram=6000M
140
141 Please not that relative paths must only be specified for the files that reside inside web application directory, all other paths must be supplied as absolute!
142
143 Furthermore, you should avoid using environment variables within the paths or options - since these will not be evaluated correctly. Instead, please explicitly specify the absolute path to anything normally evaluated from an environment variable at execution time.
144
145 If you are using JABAWS to submit jobs to the cluster (with cluster engine enabled), executables must be available from all cluster nodes the task can be sent to, also paths to the executables on the cluster e.g. ``cluster.<exec_name>.bin`` must be absolute.
146
147 Executables can be located anywhere in your system, they do not have to reside on the server as long as the web application server can access and execute them.
148
149 Cluster settings are treated as a black box, the system will just pass whatever is specified in this line directly to the cluster submission library. This is how DRMAA itself treats this settings. More exactly DRMAA ``JobTemplate.setNativeSpecification()`` function will be called.
150
151 For further details and examples of configuration please refer to the ``Executable.properties`` file supplied with JABAWS.
152
153
154 ------------
155
156 .. _jabaws_config_env_exe:
157
158 Defining Environment Variables for Executables
159 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
160
161
162 Environment variables can be defined in property
163
164 .. code:: bash
165
166     x.bin.env
167
168 Where x is one of thw executables supported by JABAWS. Several environment variables can be specified in the same line. For example.
169
170 .. code:: bash
171
172     mafft.bin.env=MAFFT_BINARIES#/homes/cengine/mafft;FASTA_4_MAFFT#/bin/fasta34;
173
174 The example above defines two environment variables with names ``MAFFT-BINARIES`` and ``FASTA_4_MAFFT`` and values ``/homes/cengine/mafft and /bin/fasta34`` respectively. Semicolon is used as a separator between different environment variables whereas hash is used as a separator for name and value of the variable.
175
176
177 ------------
178
179 .. _jabaws_config_env_mafft:
180
181 Configure JABAWS to Work with Mafft
182 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
183
184
185 If you use default configuration you do not need to read any further. The default configuration will work for you without any changes, however, if you want to install Mafft yourself then there is a couple of more steps to do.
186
187 Mafft executable needs to know the location of other files supplied with Mafft. In addition some Mafft functions depends on the fasta executable, which is not supplied with Mafft, but is a separate package. Mafft needs to know the location of fasta34 executable.
188
189 To let Mafft know where the other files from its package are, change the value of MAFFT-BINARIES environment variables. To let Mafft know where is the fasta34 executable set the value of FASTA_4_MAFFT environment variable to point to a location of fasta34 program. The latter can be added to the PATH variable instead. If you are using executables supplied with JABAWS, the path to Mafft binaries would be like ``<relative path to web application directory>/binaries/src/mafft/binaries`` and the path to fasta34 binary would be ``<relative path to web application directory>/binaries/src/fasta34/fasta34``. You can specify the location of Mafft binaries as well as fasta34 program elsewhere by providing an absolute path to them. All these settings are defined in ``conf/Executable.properties`` file.
190
191
192 ------------
193
194 .. _jabaws_config_env_limit:
195
196 Limiting the size of the job accepted by JABAWS
197 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
198
199 JABAWS can be configured to reject excessively large tasks. This is useful if you operate JABAWS service for many users. By defining a maximum allowed task size you can provide an even service for all users and prevents waste of resources on the tasks too large to complete successfully. You can define the maximum number of sequences and the maximum average sequence length that JABAWS accepts for each JABA Web Service independently. Furthermore, you can define different limits for different presets of the same web service.
200
201 By default limits are disabled. You can enable them by editing ``conf/Executable.properties`` file. You can adjust the limits according to your needs by editing ``conf/settings/<X>Limit.xml`` files.
202
203
204 .. _war_precompiled_bin:
205
206 Pre-compiled binaries
207 ~~~~~~~~~~~~~~~~~~~~~
208
209 JABAWS comes with pre-compiled x86 Linux binaries, thus on such systems JABAWS should work straight out of the box. If you are in any doubts or experience problems you may want to make sure that the binaries supplied work under your OS. The source code for these programs is also provided so you can `recompile the binaries`_ for your own architecture and exploit any optimizations that your system can provide.
210
211 To check if the bundled binaries are working in your system execute each binary, without any command line options or input files. If you see an error message complaining about missing libraries or other problems, then you probably need to `recompile the binaries`_.
212
213 Alternately, if you have already got binaries on your system, then you can simply `reuse the existing binaries`_ by updating the paths in JABAWS's `configuration files`_ so these are used instead. If you have a different version of an executable (e.g. an alignment program) which you prefer, you could use it as long as it supports all the functions JABAWS executable require. This could be the case with more recent executable. If the options supported by your chosen executable is different from the standard JABAWS executable, then you need to edit the ``ExecutableNameParamaters.xml`` configuration file.
214
215 You can try all the JABAWS functionality with the JABAWS test client or have a look at `deploying on Tomcat tips`_ if you experience any problems.
216
217 .. note:: You may want to enable logging for testing different executables as described in section 'JABAWS Internal Logging'
218
219
220 ------------
221
222 .. _war_recompile_bin:
223
224 Recompiling binaries for your system
225 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
226
227
228 If you have a fully equipped build environment on your (POSIX-like) system, then you should be able to recompile the programs from the source distributions which are included in the JABAWS war file. A script called 'compilebin.sh' is provided to automate this task.
229
230 1. In a terminal window, change the working directory to ``binaries/src``
231 2. Execute the compilebin.sh script:
232
233         .. code:: bash
234
235                 chmod +x compilebin.sh; compilebin.sh > compilebin.out;
236 3. Then run:
237
238         .. code:: bash
239
240                 chmod +x setexecflag.sh; sh setexecflag.sh
241
242         If any of the binaries was not recompiled, then a 'file not found' error will be raised.
243
244 4. Finally, restart your Tomcat server (or JABAWS application only), and `test JABAWS`_ to check that it can use the new binaries.
245
246
247 If you couldn't compile everything, then it may be that your system does not have all the tools required for compiling the programs. At the very least check that you have gcc, g++ and make installed in your system. If not install these packages and repeat the compilation steps again. You should also review the compilebin.sh output - which was redirected to compilebin.out, and any errors output to the terminal.
248
249
250 ------------
251
252 .. _war_reusing_bin:
253
254 Obtaining or reusing binaries
255 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
256
257 You could search for pre-packaged compiled executable in your system package repository or alternately, download pre-compiled binaries from each alignment program's home page. Then, either replace the executables supplied with the downloaded ones, or modify the paths defined in ``executable.properties`` as described below.
258 .. Below are some suggestions on where you may be able to get the binaries for your system.
259
260 If you would like to use the binaries you already have, then you just need to let JABAWS know where they are. To do this, edit: ``conf/Executable.properties``
261
262 When specifying paths to executables that already exist on your system, make sure you provide an absolute path, or one relative to the JABAWS directory inside webapps. For example, the default path for clustalw is defined as ``local.clustalw.bin=binaries/src/clustalw/src/clustalw2`` Alternatively, instead of changing ``Executable.properties`` you could also replace the executables bundled with JABAWS with the ones that you have, or make symbolic links to them. Then the default configuration will work for you. More information about the Executable.properties file is given in the JABAWS Configuration page.
263
264
265 ------------
266
267 .. _jabaws_config_lb:
268
269 Load balancing
270 --------------
271
272 If your cluster is busy and has significant waiting times, you can achieve a faster response by allowing the server machine to calculate small tasks and then reserve the cluster for bigger jobs. This works especially well if your server is a powerful machine with many CPUs. To do this you need to enable and configure both the cluster and the local engines. Once this is done decide on the maximum size of a task to be run on the server locally. Then, edit "# LocalEngineExecutionLimit #" preset in ``<ServiceName>Limits.xml`` file accordingly. JABAWS server then will balance the load according to the following rule: If the task size is smaller than the maximum task size for local engine, and the local engine has idle threads, then it calculates task locally otherwise it submit the task to the cluster.
273
274
275 ------------
276
277 .. _war_testing:
278
279 Testing the JABAWS Server
280 -------------------------
281
282 Access ``<your_JABAWS_server_URL>/ServiceStatus`` to test all web services. Each time you access this URL, all services are tested. For production configuration we recommend prohibiting requests to this URL for non authenticated users to prevent excessive load on the server.
283
284 Alternatively, you can use a command line client (part of the client only package) to test your JABAWS installation as described here. If you downloaded a JABAWS server package, you can use ``<your_jaba_context_name>/WEB-INF/lib/jaba-client.jar`` to test JABAWS installation as described here. If you downloaded the source code, then you could run a number of test suites defined in the build.xml Apache Ant file.
285
286
287 First of all make sure that Tomcat server is started successfully. If this was the case, then you should see JABAWS home page when you navigate to your Tomcat JABAWS context path in your browser (e.g. at ``http://myhost.compbio.ac.uk:8080/jabaws`` => ``<jabaws_server>``)
288
289 If you see it, then it is time to make sure that web services are working too. The easiest way to do this is to access Services Status page available from the main JABAWS web page menu.
290
291 If you need to monitor web service health automatically when the best option is to use service checker that responds with the standard HTTP status code. To access this checker use the following URL:
292
293 **Using JABAWS service status checker**
294
295 If you see it, then it is time to make sure that web services are working too. The easiest way to do this is to access Services Status page available from the main JABAWS web page menu.
296
297 If you need to monitor web service health automatically when the best option is to use service checker that responds with the standard HTTP status code. To access this checker use the following URL: ``<jabaws-server>/HttpCodeResponseServiceStatus`` or alternatively ``<jabaws-server>/man_serverwar.jsp``
298
299 This page returns code 200, and no page context if all services are operational, 503 if one of the services have problems. You can also check each web service individually by providing the name of the web service to check at the end of the service checker URL like this: ``<jabaws_server>/HttpCodeResponseServiceStatus/ClustalWS``
300
301
302 Upon request, the service status checker will examine the health of the ClustalWS web service only. If the service name is not valid, then the service checker will return code 400.
303
304 **Using command line client**
305
306 Alternatively, you should be able to use the test program which can be found in ``<webapplicationpath>/WEB-INF/lib/jabaws-client.jar`` file. To run the tests type:
307
308 .. code:: bash
309
310       java -jar jabaws-client.jar -h=<Your web application server host name, port and JABAWS context path>
311
312 For example to test all JABAWS web services on host myhost.compbio.ac.uk type:
313
314 .. code:: bash
315
316       java -jar jabaws-client.jar -h=http://myhost.compbio.ac.uk:8080/jabaws
317
318
319 You can choose a particular web server using -s option like this java -jar jabaws-client.jar -h=http://myhost.compbio.ac.uk:8080/jabaws -s=ClustalWS This command line assumes that java executable is in your path and jabaws-client.jar is located in the current directory.
320
321 An example of the report testing tool produces for operating web service looks like this:
322
323 .. code:: bash
324
325       Connecting to service MuscleWS on http://myhost.compbio.ac.uk:8080/jabaws ... OK
326       Testing alignment with default parameters:
327       Queering job status...OK
328       Retrieving results...OK
329       Testing alignment with presets:
330       Aligning with preset 'Protein alignment(Fastest speed)'... OK
331       Aligning with preset 'Nucleotide alignment(Fastest speed)'... OK
332       Aligning with preset 'Huge alignments (speed-oriented)'... OK
333       Queering presets...OK
334       Queering Parameters...OK
335       Queering Limits...OK
336       Queering Local Engine Limits...OK
337       Check is completed service MuscleWS IS WORKING
338
339 An example of the response of a web service which is deployed but is not operating is below:
340
341 .. code:: bash
342
343       Connecting to service ProbconsWS on http://localhost:8080/ws ... OK
344       Testing alignment with default parameters:FAILED
345       Service ProbconsWS IS NOT FUNCTIONAL
346
347
348 If the web server did not respond the message looks like following:
349
350 .. code:: bash
351
352       Connecting to service TcoffeeWS on http://localhost:8080/ws ... FAILED
353
354
355 ------------
356
357 .. _war_logging:
358
359 JABAWS internal logging
360 -----------------------
361
362 JABAWS can be configured to log what it is doing. This comes in handy if you would like to see who is using your web services or need to chase some problems. JABAWS uses log4j to do the logging, the example of log4j configuration is bundled with JABAWS war file. You will find it in the ``/WEB-INF/classes/log4j.properties`` file. All the lines in this file are commented out. The reason why the logging is disabled by default it simple, log4j has to know the exact location of where the log files are stored. This is not known up until the deployment time. To enable the logging you need to define logDir property in the log4j.properties and uncomment section of the file which corresponds to your need. More information is given in the log4j.properties file itself. Restart the Tomcat or the JABAWS web application to apply the settings.
363
364 After you have done this, assuming that you did not change the log4j.properties file yourself, you should see the application log file called activity.log. The file called activity.log. The amount of information logged can be adjusted using different logging levels, it is reduced in the following order of log levels TRACE, DEBUG, INFO, WARN, ERROR, FATAL.
365
366 If you would like to know who is using your services, you might want to enable Tomcat request logging.
367
368 ------------
369
370 .. _war_logging_req:
371
372 JABAWS requests logging
373 ~~~~~~~~~~~~~~~~~~~~~~~
374
375 Enable Tomcat log valve. To do this uncomment the following section of <tomcat_root>/conf/server.xml configuration file.
376
377 .. code-block:: xml
378
379     <Valve className="org.apache.catalina.valves.AccessLogValve" directory="logs"
380               prefix="localhost_access_log." suffix=".txt" pattern="common" resolveHosts="false"/>
381
382
383 The following information will be logged:
384
385 +--------------+------------------------------+-------------------------------+---------------+------------------------+
386 | Remote IP    |  Date                       |  Method server_URL protocol    |  HTTP status  | Response size in bytes |
387 +==============+==============================+===============================+===============+========================+
388 | 10.31.11.159 | [10/Feb/2010:16:51:32 +0000] | "POST /jws2/MafftWS HTTP/1.1" |  200          | 2067                   |
389 +--------------+------------------------------+-------------------------------+---------------+------------------------+
390
391 Which can be processed in various programs for log analysis, such as WebAlizer, Analog, AWStats.
392
393
394 ------------
395
396 .. _jabaws_config_ga:
397
398 JABAWS and Google Analytics
399 ---------------------------
400
401
402 JABAWS reports web services usage to our group Google Analytics (GA) account. JABAWS usage statistics are collected for funding and reporting purposes, and no private information is collected. The data sent by JABAWS is as follows:
403
404 1. The IP address of the JABAWS server machine (the server IP can anonymized see ``conf/GA.properties`` config file)
405 2. The name of the web service that was called.
406 3. A few details of the system such as JABAWS version, java version, user language, color depth, screen resolution and character encoding.
407
408 Google Analytics can be disabled or adjusted by removing/editing ``conf/GA.properties`` Google Analytics (GA) settings file. We would appreciate it greatly if you could leave it on!
409
410 All calls to GA are very lightweight, completed asynchronously, create very little overhead and do not influence the server response time or performance.
411
412
413 ------------
414
415 .. _war_contents:
416
417 JABAWS War File Content
418 -----------------------
419
420 +---------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
421 | Directory           | Content description                                                                                                                                      |
422 +=====================+==========================================================================================================================================================+
423 | conf/ contains      | configuration files such as Executable.properties, Engine.local.properties, Engine.cluster.properties                                                    |
424 +---------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
425 | conf/settings       | Contains individual executable description files. In particular XXXParameters.xml, XXXPresets.xml, XXXLimits.xml where XXX is the name of the executable |
426 +---------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
427 | ExecutionStatistics | The database for storing the execution statistics                                                                                                        |
428 +---------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
429 | statpages           | Web pages for usage statistics visialization and webservices status queries                                                                              |
430 +---------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
431 | jobsout/            | Contains directories generated when running an individual executable. E.g. input and output files and some other task related data (optional)            |
432 +---------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
433 | binaries/           | Directory contains native executables - programs, windows binaries (optional)                                                                            |
434 +---------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
435 | binaries/src        | Contains source of native executables and Linux i386 binaries                                                                                            |
436 +---------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
437 | binaries/windows    | Contains binaries for MS Windows operating system                                                                                                        |
438 +---------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
439 | binaries/matrices   | Substitution matrices                                                                                                                                    |
440 +---------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
441 | WEB-INF             | Web application descriptor                                                                                                                               |
442 +---------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
443 | WEB-INF/lib         | Web application libraries                                                                                                                                |
444 +---------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
445 | WEB-INF/classes     | log4j.properties - log configuration file (optional)                                                                                                     |
446 +---------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
447 | static              | Static content such as CSS, JavaScript and Image files                                                                                                   |
448 +---------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
449
450 +---------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
451 | **Help Pages**      |                                                                                                                                                          |
452 +=====================+==========================================================================================================================================================+
453 | /                   | help pages, index.html is the starting page                                                                                                              |
454 +---------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
455 | `dm_javadoc`_       | JavaDoc for the JABAWS Data Model                                                                                                                        |
456 +---------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
457 | `full_javadoc`_     | JavaDoc for the complete JABAWS                                                                                                                          |
458 +---------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
459 | `prog_docs`_        | Documentation for programs that are included in JABAWS                                                                                                   |
460 +---------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
461
462
463
464 .. links
465 .. _war file content table: advanced.html#jabaws_war_file_content
466 .. _dm_javadoc: http://www.compbio.dundee.ac.uk/jabaws/dm_javadoc/index.html
467 .. _full_javadoc: http://www.compbio.dundee.ac.uk/jabaws/full_javadoc/index.html
468 .. _prog_docs: http://www.compbio.dundee.ac.uk/jabaws/prog_docs/
469 .. _test JABAWS: advanced.html#testing-the-jabaws-server
470 .. _deploying on Tomcat tips: war.html
471 .. _recompile the binaries: advanced.html#recompiling-binaries-for-your-system
472 .. _configuration files: advanced.html#jabaws-configuration
473 .. _reuse the existing binaries: advanced.html#obtaining_or_reusing_binaries