From 88b73d27efc5ccccfd8fe362a34fe669ca0179d9 Mon Sep 17 00:00:00 2001 From: Suzanne Duce Date: Thu, 3 Apr 2014 09:59:56 +0100 Subject: [PATCH] JWS-86 made few changes to text, plus couple of links were faulty so changed ClustalW, Muscle and Tcoffee. --- website/jabaws_funding.html | 5 +++-- website/man_about.html | 20 ++++++++++---------- website/man_awscloud_ec2.html | 6 +++--- website/man_dev.html | 26 +++++++++++++------------- website/man_stats.html | 28 ++++++++++++++-------------- 5 files changed, 43 insertions(+), 42 deletions(-) diff --git a/website/jabaws_funding.html b/website/jabaws_funding.html index 6af833b..f01d75b 100644 --- a/website/jabaws_funding.html +++ b/website/jabaws_funding.html @@ -40,9 +40,10 @@

JABAWS FUNDING

-The primary funding for JABAWS development is provided by the BBSRC Bioinformatics and Biological Resources Grant: +The current funding for JABAWS development is provided by the BBSRC Bioinformatics and Biological Resources Grant: "The Dundee Resource for Protein Structure Prediction and Sequence Analysis" 2013 to 2018 (BB/J019364/1) to Prof. -Geoff Barton. Further support comes from Wellcome Trust Strategic Grant: 100476. +Geoff Barton.
+Further support comes from Wellcome Trust Strategic Grant: 100476.

diff --git a/website/man_about.html b/website/man_about.html index 1257b60..084288d 100644 --- a/website/man_about.html +++ b/website/man_about.html @@ -70,11 +70,11 @@ 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. + Future versions of JABAWS will incorporate other tools.

Getting JABAWS

- JABAWS consists of a server and client, but unlike most bioinformatics web service systems, you can download and + 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. 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 @@ -90,10 +90,10 @@

  • 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, +
  • 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.
  • 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.
    • +
  • 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.
    • @@ -141,11 +141,11 @@ section (registration is required). JABAWS Version 2.1 (Released 1st Oct 2013)

    Several new web services are available in this version of JABAWS:

    @@ -165,7 +165,7 @@ section (registration is required).
  • JABAWS could not deal with FASTA records with '>' symbols in the record identificator
  • Change of parameter description for AAcon: parameters have been replaced with options for calculation methods. This allows a user to get several AAcon's conservation scores in one call
    • -
  • JABAWS never cleaned up job directories. Now JABAWS deletes the job directory if it exist longer then a period defined in Engine.properties
    • +
  • JABAWS never cleaned up job directories. Now JABAWS deletes the job directory if it exist longer than a period defined in Engine.properties
  • Default web security has been incompatible with Tomcat 7.0.31 and newer
  • Documentation has been updated
    • @@ -216,7 +216,7 @@ section (registration is required). 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; but in addition, offers some additional methods which simplify + 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.

    diff --git a/website/man_awscloud_ec2.html b/website/man_awscloud_ec2.html index dce0982..a53cb98 100644 --- a/website/man_awscloud_ec2.html +++ b/website/man_awscloud_ec2.html @@ -69,14 +69,14 @@ the hardware click continue. select hardware -
  • You should not need to customize anything on this page, continue to the next. +
  • You should not need to customize anything on this page, continue to the next page. keys
  • At the "Create a key pair" step, choose "Proceed without a key pair" unless you want to access JABAWS server via SSH.
  • Create a new security group with a single HTTP (80) port as shown below. You may want to add SSH (22) port if - you are planning to manage your instance via SSH. For starting/stopping your JABAWS instance SSH is not necessary, + you are planning to manage your instance via SSH. For starting/stopping your JABAWS instance, SSH is not necessary, you can do this from the Amazon Webservices Console (AWS). ese
    • @@ -86,7 +86,7 @@
  • At this point you should have JABAWS instance up and running. Your AWS console should look something like this:
    • -
  • Now you can consume JABAWS web services by accessing the public DNS address of your JABAWS server instance. +
  • Now you can run JABAWS web services by accessing the public DNS address of your JABAWS server instance. For instance, to register it with Jalview, just add the new JABAWS web server. Prefix your instance public DNS address with http:// e.g. type: http://<public DNS>. The JABAWS instance on the screenshot can be accessed on http://ec2-46-137-50-196.eu-west-1.compute.amazonaws.com. diff --git a/website/man_dev.html b/website/man_dev.html index 375ac5e..a602a7b 100644 --- a/website/man_dev.html +++ b/website/man_dev.html @@ -104,7 +104,7 @@ JABAWS command line client -

    Additional utility libraries this client depend upon is the compbio-util-1.3.jar and compbio-annotation-1.0.jar.
    +

    Additional utility libraries that this client depend upon is the compbio-util-1.3.jar and compbio-annotation-1.0.jar.
    Please refer to a data model javadoc for a detailed description of each class and its methods.

    @@ -112,7 +112,7 @@

    For a complete working example of JABAWS command line client please see compbio.ws.client.Jws2Client class. JABAWS command line client source code is available from the download page. Please note that for now all -the examples are in Java other languages will follow given a sufficient demand.

    +the examples are in Java, other languages will follow if there is sufficient demand.

    Download a binary JABAWS client. Add the client to the class path. The following code excerpt will connect your program to Clustal web service deployed in the University of Dundee.

    @@ -200,8 +200,8 @@ section, the actual alignment can be obtained as follows:

    1) List<FastaSequence> fastalist = SequenceUtil.readFasta(new FileInputStream(file));
    2) String jobId = msaws.align(fastalist);
    3) Alignment alignment = msaws.getResult(jobId);

    -

    Line one loads FASTA sequence from the file
    - Line two submits them to web service represented by msaws proxy
    +

    Line one loads FASTA sequence from the file.
    + Line two submits them to web service represented by msaws proxy.
    Line three retrieves the alignment from a web service. This line will block the execution until the result is available. Use this with caution. In general, you should make sure that the calculation has been completed before attempting retrieving results. This is to avoid keeping the connection to the server on hold for a prolonged periods of time. @@ -228,7 +228,7 @@ calculation has been completed before accessing the results. You can do it like 5) Alignment alignment = msaws.getResult(jobId);

    Line one obtains the lists of presets supported by a web service.
    Line two return a particular Preset - by its name
    + by its name.
    Lines three to five are doing the same job as in the first aligning sequences example.

    Aligning with custom parameters

    1) RunnerConfig options = msaws.getRunnerOptions();
    @@ -243,14 +243,14 @@ calculation has been completed before accessing the results. You can do it like 9) String jobId = msaws.customAlign(fastalist, arguments);
    10) Alignment alignment = msaws.getResult(jobId);

    Line one obtains the RunnerConfig object that holds information on supported parameters and their values
    - Line two retrieve a particular parameter from the holder by its name
    + Line two retrieve a particular parameter from the holder by its name.
    Lines three sets a value to this parameter which will be used in the calculation.
    - Line four and five do the same but for another parameter
    - Line 6 makes a List to hold the parameters
    - Line seven puts the parameters into that list
    + Line four and five do the same but for another parameter.
    + Line 6 makes a List to hold the parameters.
    + Line seven puts the parameters into that list.
    Line eight - and ten is the same as in previous examples
    - Line nine submit an alignment request with the sequences and the parameters
    + and ten is the same as in previous examples.
    + Line nine submit an alignment request with the sequences and the parameters.
    The names of all the parameters supported by a web service e.g. "PAM300" can be obtained using options.getArguments() method. Further details on the methods available from RunnerConfig object are available from the @@ -263,7 +263,7 @@ calculation has been completed before accessing the results. You can do it like

    A complete client example

    Finally, a complete example of the program that connects to JABAWS Clustal service and aligns sequences using -one of the Clustal web service preset. Three is also a PDF version of +one of the Clustal web service presets. There is also a PDF version of this example with syntax highlighted. The text comments are commented by block style comments e.g. /* comment */, the alternatives given in the code are line commented // comment. You may want to remove line style comments to test alternatives of the functions. All you need for this to work is a @@ -405,7 +405,7 @@ For a more detailed description of all available types and their functions pleas

    JABAWS are the standard JAX-WS SOAP web services, which are WS-I basic profile compatible. This means that you could use whatever tool your language has to work with web services. Below is how you can -generate portable artifacts to work with JABAWS from Java. However, if programming in Java we recommend using our client library as +generate portable artifacts to work with JABAWS from Java. However if programming in Java, we recommend using our client library as it provides a handful of useful methods in addition to plain data types.

    wsimport -keep http://www.compbio.dundee.ac.uk/jabaws/ClustalWS?wsdl

    diff --git a/website/man_stats.html b/website/man_stats.html index 63e0657..1f322d8 100644 --- a/website/man_stats.html +++ b/website/man_stats.html @@ -61,14 +61,14 @@
  • Configuring JABAWS execution statistics

    • Summary of Usage

    -

    JABAWS comes with a web application for visualizing usage statistics. The screenshot below shows the main page of this application. Each month is a link to the detailed usage statistics for this month described later. Please note however, that the links to the detailed monthly statistics are only available for authenticated users in the role admin. There is a link at the bottom of the page that would let you login, if you have not done so.

    -

    If you are using JABAWS VA (Virtual Appliance) then the username is jabaws and password is not defined, e.g. empty.

    +

    JABAWS comes with a web application for visualizing usage statistics. The screenshot below shows the main page of this application. The individual month is linked to detailed usage statistics (described later). Please note, that the links to the detailed monthly statistics are only available for authenticated users in the role admin. There is a link at the bottom of the page that lets you login, if you have not done so.

    +

    If you are using JABAWS VA (Virtual Appliance) then the username is jabaws and password is not defined, i.e. empty.

    If you have deployed a JABAWS WAR file, then please see the configuring privileged access for Tomcat web application server section for further details.

    JABAWS usage statistics

    The table contains the number of jobs processed by JABAWS per month, for the whole period when the statistics was collected

    For each month the table contains the following information.

    The summary for each column is displayed in the last row of the table.

    Authentication

    -

    Authentication lets you see the detailed usage statistics. If you are using JABAWS VA (Virtual Appliance) then the username is jabaws and password is not defined, e.g. empty. In other cases you need to ask your system administrator for it.

    +

    Authentication lets you see the detailed usage statistics. If you are using JABAWS VA (Virtual Appliance) then the username is jabaws and password is not defined, i.e. empty. In other cases you need to ask your system administrator for it.

    Detailed Usage Statistic

    Detailed execution statistics for each month is available for authenticated users only.

    JABAWS one month usage statistics

    -

    Each table contains the number of jobs processed by JABAWS during the period of time specified in the title.

    +

    Each table contains the number of jobs processed by JABAWS during the period of time specified in the title:

    -Each table contains the following information for each web service +Each table contains the following information for each web service:

    Job List

    -

    Please note that if you deployed JABAWS WAR, in order to be able to navigate to the job directory from this view the application server may need to be configured. Please see Configuring JABAWS execution statistics section for further details.

    +

    Please note that if you deployed JABAWS WAR, in order to be able to navigate to the job directory from this view, the application server may need to be configured. Please see Configuring JABAWS execution statistics section for further details.

    JABAWS - job list

    -

    Columns

    +

    Columns:

    JABAWS Job Directory Content

    JABAWS- job details

    @@ -117,10 +117,10 @@ Each table contains the following information for each web service

    procError.txt and procOutput.txt files contains the content of the standard out and standard error streams of the process.

    result.txt file contains the results.

    input.txt file contains input into the process.

    -

    There are maybe other files depending on the nature of the job, but the one described above will present in most cases. In this example, stat.log file stories the execution statistics generated by the process (clustal executable in this example).

    +

    There are maybe other files depending on the nature of the job, but the one described above will be present in most cases. In this example, stat.log file stories the execution statistics generated by (clustal executable in this example) process.

    If you have deployed JABAWS WAR file or made changes to JABAWS configuration you may need to make a few changes to the Tomcat configuration to be able to see the content of the job directory. Please see Configuring JABAWS execution statistics section for further details.

    Configuring JABAWS execution statistics

    -

    JABAWS execution statistics is a multi-component system. First is a crawler which job is to collect and preprocess the statistics from the job temporary directories and record the collected statistics into the database. The second part of the system is a web application which job is to visualise the statistics from the database.

    +

    JABAWS execution statistics is a multi-component system. First is a crawler whose job is to collect and preprocess the statistics from the job temporary directories and record the collected statistics into the database. The second part of the system is a web application whose job is to visualise the statistics from the database.

    It is possible to enable/disable the statistics collector by changing the following properties in the conf/Cluster.engine.properties and conf/Local.engine.properties files.

    # Enable/disable cluster statistics collector true = enable, false = disable
    cluster.stat.collector.enable=false -- 1.7.10.2