X-Git-Url: http://source.jalview.org/gitweb/?a=blobdiff_plain;f=website%2Fman_about.html;h=3c57829c686b069e32c1b9ae82ca9ed21840b303;hb=14c406769ac5cd4acfbc4819bb3dc967a51e4bb6;hp=1a2f26ebd25d580281a765db919f528a7b9fdfe0;hpb=a00dd4ba64bebc4d0801720e200c8fea34c91eec;p=jabaws.git diff --git a/website/man_about.html b/website/man_about.html index 1a2f26e..3c57829 100644 --- a/website/man_about.html +++ b/website/man_about.html @@ -1,51 +1,56 @@ - + + -Java Bioinformatics Analyses Web Services (JABAWS) manual - About - - - +Java Bioinformatics Analyses Web Services (JABAWS) Server Virtual Appliance Manual + + +
+ -
- +
+ + +
+ -
+ +

JABAWS MANUAL

About

@@ -59,19 +64,30 @@
  • Programmatic access to JABAWS
    • -

    What is JABAWS?

    -

    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) from Jalview. - Future versions of JABAWS will incorporate many other tools.

    +

    + 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) from Jalview. + Future versions of JABAWS will incorporate many other tools. +

    Getting JABAWS

    -

    JABAWS consists of a server and 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. 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. 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 client is what you need.

    +

    + JABAWS consists of a server and 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. 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. 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 client is what you need.

    JABAWS Benefits

    • Can be deployed on most operating systems, as a VMware or other compatible Virtual Appliance or a Tomcat Java Web Application.
    • Comes complete with sources and binaries for all the bioinformatics programs that it runs.
    • Can operate as a stand alone server or one that submits jobs to a cluster via DRMAA.
    • Easy to access from Jalview using its graphical client, or using the JABAWS command line client.
      • -
    • Clients can submit jobs to any JABAWS servers that you 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.
      • +
    • Clients can submit jobs to any JABAWS servers that you 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.
    • Local or intranet installation eliminates any security concerns you might have about sending sensitive data over the internet.
    • 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.
    @@ -98,52 +114,55 @@ -

    What is new in JABAWS 2?

    -

    Comparing to previous version of JABAWS JABAWS 2 offers a greater number of diverse web services, Amazon EC 2 integration and improved easy of use. It contains

    -
    • updates for all multiple sequence alignment services
      • +

      What is new in JABAWS 2.0.1?

      +

      Compared to JABAWS 1, JABAWS 2.0.1 offers a greater number and diversity of web services, Amazon EC2 integration and improved easy of use. It contains

      +
      • updates for all multiple sequence alignment services
      • four new protein disorder prediction services
        • -
      • Clustal Omega multiple sequence alignment web service
        • -
      • amino acid conservation service
        • +
      • Clustal Omega multiple sequence alignment web service
        • +
      • amino acid conservation service
      • web services execution statistics visialization
        • -
      • web services status check from a web page
        • +
      • web services status check from a web page
      • VirtualBox support was dropped in favour of VMware
        • -
      • new WAR package for Mac users
        • -
      • Amazon Machine Image (AMI) distributive to enable users to use JABAWS on the EC2 cloud
        • -
      • Improved web services client API
        • -
      • Simplified WAR package installation
        • +
      • new WAR package for Mac users
        • +
      • Amazon Machine Image (AMI) distributive to enable users to use JABAWS on the EC2 cloud
        • +
      • Improved web services client API
        • +
      • Simplified WAR package installation
      - -

      What is JABAWS client?

      -

      A JABAWS client is a program that lets you run the bioinformatics methods for which a JABAWS server provides web services. -The most basic JABAWS client is a command line Java application which can call any of the JABAWS web services methods -on any instance of JABAWS Server that it can reach over the web. It is useful if you -want to test, or execute the programs provided by a JABAWS server in your own scripts, and do not want to handle any web service -specific details. The client is open source, so you can also use its source code to find -out how to work with JABA Web Services if you would like to write your own client -software. Jalview, which is a multiple sequence alignment and analysis application, provides a graphical JABAWS client. This client has the same -functionality as the command line client, but instead allows JABAWS services to be accessed in a more user-friendly manner, through a graphical user interface.

      +

      What is JABAWS client?

      + +

      + A JABAWS client is a program that lets you run the bioinformatics methods for which a JABAWS server provides web + services. The most basic JABAWS client is a command line Java application which can call any of the JABAWS web + services methods on any instance of JABAWS Server that it can reach over the web. It is useful if you want to + test, or execute the programs provided by a JABAWS server in your own scripts, and do not want to handle any web + service specific details. The client is open source, so you can also use its source code to find out how to work + with JABA Web Services if you would like to write your own client software. + Jalview, which is a multiple sequence alignment and analysis application, + provides a graphical JABAWS client. This client has the same functionality as the command line client, but + instead allows JABAWS services to be accessed in a more user-friendly manner, through a graphical user interface. +

      JABAWS versions compatibility and Jalview support

      -

      JABAWS version 2 is fully backward compatible with JABAWS version 1. That means that all JABAWS 1 clients should be able to use JABAWS 2 instead. However, they will be limited to the multiple sequence alignment web services only. To benefit of new web services introduced in JABAWS 2 the clients have to be updated.
      -Jalview since version 2.6.1 integrates fully with JABAWS 1. Therefore it will be possible to use any versions of Jalview after 2.6.1 with JABAWS 1. However, the full support for JABAWS 2 is introduced in Jalview version 2.8 or later.

      +

      + JABAWS version 2.0.1 is fully backward compatible with JABAWS v1.0 and v2.0. That means that all JABAWS v1.0 and + v2.0 clients should also be able to use JABAWS 2.0.1 services. To access the analysis web services introduced in + JABAWS 2.0, however, clients that were designed for JABAWS v1.0 must be updated. +

      Programmatic access to JABAWS

      -

      JABA 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 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, however, then 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; -but in addition, offers some additional methods which simplify working with JABAWS. For more information please refer to the -data model javadoc. +

      +JABA 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 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, however, +then 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; but in addition, offers some additional methods which simplify +working with JABAWS. For more information please refer to the data model javadoc.

      -
    - - - - -
    +
    +
    + + - -