website/docs/v_2_2_0/_sources/man/getting_started.rst.txt

   1 Getting Started
   2 ===============
   3
   4 JABAWS stands for JAva Bioinformatics Analysis Web Services. As the name suggests, JABAWS is a collection of web services for bioinformatics, and currently provides services that make it easy to access well-known multiple sequence alignment and protein disorder prediction programs (see the list of currently supported programs [link]). Future versions of JABAWS will incorporate other tools.
   5
   6 JABAWS consists of a server and a client, but unlike most bioinformatics web-service systems, you can download and run both parts on your own computer! If you want a server just for yourself, then download and install the JABAWS Virtual Appliance (VA) [link]. It requires no configuration and is simple to install. If you want to install JABAWS for your lab or institution then download the JABAWS Web Application aRchive (WAR) [link]. It is slightly more complicated to configure but is very straightforward too. Finally, if you want to script against any version of JABAWS or are interested in writing your own client, the JABAWS command line (CLI) client [link] is what you need.
   7
   8
   9 ------------
  10
  11 .. _benefits:
  12
  13 JABAWS Benefits
  14 ---------------
  15
  16 * Can be deployed on most operating systems, as a VMware or compatible Virtual Appliance, as well as a Tomcat Java Web Application.
  17 * Comes complete with sources and binaries for all the bioinformatics programs that it runs.
  18 * Can operate as a stand alone server or one that submits jobs to a cluster via DRMAA [link].
  19 * Easy to access from Jalview [link] using its graphical client, or using the JABAWS command line client.
  20 * Clients can submit jobs to any JABAWS servers that they might want to access, such as the one running on your local computer, your lab's server, or the publicly available services at the University of Dundee [link].
  21 * Local or intranet installation eliminates any security concerns you might have about sending sensitive data over the internet.
  22 * Wide range of configuration options to control size of jobs accepted by a server, and the command line options available for the program run by a service.
  23
  24
  25 ------------
  26
  27 .. _distributions:
  28
  29 JABAWS Distributions
  30 --------------------
  31
  32 .. danger:: Merge the downloads here
  33
  34 .. tip:: To help you choose the JABAWS distribution that better suits your needs and read on the quickstart guides below.
  35
  36 **I want to use JABAWS for...**
  37
  38 * :ref:`jabaws-jalview-public` - Running JABAWS services through Jalview on the JABAWS *public* server
  39 * :ref:`jabaws-cli` - Accessing a *public* or *private* JABAWS server using the JABAWS client
  40 * :ref:`jabaws-war` - Running JABAWS for my group, lab, or organization on the *local* infrastructure
  41 * :ref:`jabaws-va` - Running JABAWS services through Jalview or the CLI client on a *private* virtual machine server
  42
  43
  44 ------------
  45
  46 .. _jabaws-jalview-public:
  47
  48 Jalview and the JABAWS Public Server
  49 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  50
  51 This is the easiest way to run JABAWS web-services. Simply launch Jalview [link] and run any of the methods provided under the 'Web Service' menu. Jalview uses the public JABAWS server by default. If you are concerned about privacy or want to run sensitive analysis on your own hardware, you can either setup a local JABAWS Virtual Appliance (VA) [link] or configure the JABAWS Web Application aRchive (WAR) [link] in your infrastructure.
  52
  53
  54 ------------
  55
  56 .. _jabaws-cli:
  57
  58 Command Line Client (CLI)
  59 ~~~~~~~~~~~~~~~~~~~~~~~~~
  60
  61 This is a single Java archive which contains the JABAWS command line interface (CLI) client. It allows anyone who wants to connect to the JABAWS web-services running at the University of Dundee's Public Server, or to run a local private JABAWS server from their own software. You can read more about how to use JABAWS command line (CLI) client given in the documentation pages [link][fix], but a brief instructions are given below:
  62
  63 1. Download the Client Jar file [link]
  64 2. Download and install Java (version 1.6) [link]
  65 3. Provided that you have the Java ready to run, you can get command line help by changing to the directory where you downloaded the client jar, and typing:
  66
  67       .. code:: bash
  68
  69             java -jar jaba-client.jar
  70
  71
  72 The JABA Web Services are WS-I compliant. This means that you can access them from any language that has libraries or functions for consuming interoperable SOAP web services.
  73
  74
  75 ------------
  76
  77 .. _jabaws-va:
  78
  79 Virtual Appliance (VA)
  80 ~~~~~~~~~~~~~~~~~~~~~~
  81
  82 The Virtual Appliance (VA) package allows you to run a JABAWS server installed on TurnKey Linux as a virtual machine on your laptop or desktop computer. A complete guide to the JABAWS VA is given in the documentation pages [link][fix], but for the impatient, brief instructions are given below:
  83
  84 If you work on Windows, Linux or Unix:
  85
  86 1. Download JABAWS Virtual Appliance [link]
  87 2. Download and install VMWare Player [link]
  88 3. Unpack the JABAWS virtual appliance and open it with VMware Player
  89
  90 If you work on Mac do the same using VMware Fusion [link].
  91
  92 **Testing**
  93
  94 To check that your JABAWS virtual appliance is working visit the Services Status page available from the main JABAWS menu. For this enter the JABAWS URL for your new server into a web browser. This is shown once the appliance is booted up.
  95
  96 Alternatively you can use Jalview to complete the testing.
  97
  98 1. Launch the desktop version of Jalview [link]
  99 2. Open the Jalview desktop's preferences panel (from the Tools->Preferences menu option), select the ``Webservices`` panel and press the ``New Service URL`` button.
 100 3. Enter the JABAWS URL for your new server. This is shown once the appliance is booted up.
 101
 102
 103 ------------
 104
 105 .. _jabaws-war:
 106
 107 Web Application aRchive (WAR)
 108 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 109
 110 The JABAWS Web Application aRchive (WAR) is for anyone who wants to run JABAWS for their group, lab or organization, or wants to enable their local JABAWS server to use the cluster or perform very large tasks. Complete documentation is provided in the documentation pages [link][fix], but brief instructions are given below:
 111
 112 1. Download the JABAWS WAR file [link]
 113 2. Download and install Apache-Tomcat [link]
 114       You will need at least Tomcat version 5.5 of (we would recommend version 7.0) and at least Java 1.6 (i.e. JAVA 6).
 115 3. Drop the JABAWS WAR file into ``tomcat/webapps`` directory.
 116 4. (Re)start the Tomcat.
 117 5. Once the tomcat has started, it should automatically unpack the WAR into the webapps directory (if it doesn't, simply unpack the WAR archive).
 118 6. If you are on Mac or other unix-like architecture with GNU compilers available or you'd like to get a maximum performance
 119     ``cd`` to ``webapps/jabaws/binaries/src/`` and execute ``./compilebin.sh`` script to compile all binaries JABAWS depends on.
 120
 121 **Testing**
 122
 123 You can test that your JABAWS server is working in several ways.
 124
 125 1. Visit Services Status page available from the JABAWS main page using your web browser.
 126 2. If you are working on the command line, then use the command line client shipped with the JABAWS war to test it by running:
 127
 128       .. code:: bash
 129
 130             java -jar <Path to tomcat WebApp directory>/jabaws/WEB-INF/lib/jaba-client.jar -h=http://localhost:8080/jabaws
 131
 132     In this example we assumed that your JABAWS server URL is ``http://localhost:8080`` and JABAWS context path is *jabaws*
 133 3. Alternately, you can point Jalview at your new server:
 134
 135     1. Launch the desktop version of Jalview [link]
 136     2. Open the Jalview desktop's preferences panel (from the Tools->Preferences menu option), elect the Webservices panel and press the New Service URL button.
 137     3. Enter the URL for the tomcat server, including the context path for the JABAWS web app (e.g. http://localhost:8080/jabaws).