spacer


spacer
EBIEMBL-EBI Web Servicesservicesarchivestructurewsmaxsprout
Table of Contents

WSMaxsprout

Important

The WSMaxsprout service was decommissioned on Tuesday 27th November 2012, and replaced by the following services:

The service documentation and clients below are historical and provided solely for reference purposes.

Description

MaxSprout 1) is a fast database algorithm for generating protein backbone and side chain co-ordinates from a C(alpha) trace. The backbone is assembled from fragments taken from known structures. Side chain conformations are optimised in rotamer space using a rough potential energy function to avoid clashes.

For more information about this tool see:

Web service registry entries:

Clients

Sample clients are provided for a number of programming languages. For details of how to use these clients, download the client and run the program without any arguments.

Language Download Requirements
C# .NET Executable: wsmaxsprout.exe; Source: wsmaxsprout.cs A .NET runtime environment. If building from source development tools are also required. See the .NET tutorial for details.
Java Executable jar: WSMaxsprout.jar; Source: WSMaxsproutClient.java Axis 1.4; All dependencies, including Axis 1.4 and Commons-CLI, are available in lib-1.4.zip.
Perl maxsprout.pl SOAP::Lite
Taverna 1.x EBI_MaxSprout Taverna

For further details see WSMaxsprout Clients.

Workflows

In addition to these sample clients users have submitted workflows using these services to the myExperiment workflow repository. See workflows using the WSMaxsprout Web Service for a list.

WSDL

http://www.ebi.ac.uk/Tools/webservices/wsdl/WSMaxsprout.wsdl

Service API

runMaxsprout(params, content)

Submits a MaxSprout job to the service.

Arguments:

  • params an instance of the inputParams data structure.
  • content a list of data data structures describing the query structure.

Returns: a string containing the job ID (jobid).

checkStatus(jobId)

Get the status of a job.

Arguments:

  • jobid the job identifier of the job to check status of.

Returns: a string indicating the status of the job. Current values are:

  • DONE: job has finished, and the results can then be retrieved.
  • ERROR: the job failed or no results where found
  • NOT_FOUND: the job id is no longer available (job results are deleted after 24 h)
  • PENDING: the job is in a queue waiting processing
  • RUNNING: the job is currently being processed

getResults(jobid)

Get details of the result types available.

Arguments:

  • jobid the job identifier of the job to get result types for.

Returns: an array of WSFile structures describing the available result types for the job.

poll(jobid, type)

Wait until the job has finished and get the specified type of result data.

Arguments:

  • jobid the job identifier of the job to get result from.
  • type a string specifying the type of result to retrieve. See getResults(jobid) and WSFile for details of how to obtain valid values.

Returns: a base64 encoded string containing the result data. Depending on the SOAP library and programming language used the result may be returned in decoded form.

data

Structure containing the input data for the job

Attribute Type Description Default
type string Type of content being used. Value: 'sequence' required
content string Structure containing C(alpha) trace in PDB format required

inputParams

A structure containing the parameters required to run the job.

Attribute Type Description Default
async boolean Asynchronous submission (recommended) false
email string Valid email address. See Why do you need my e-mail address? required

WSFile

Structure describing a result type. Returned by the getResults(jobid) method.

Attribute Type Description
type string Symbolic name of the result type. Used with the poll(jobid, type) method.
ext string Recommended file extension for this result type.

Contact

If you have any questions or comments, or you plan to use this service as part of a course or for a high number of submissions, please contact us EMBL-EBI Support.

1) Holm L. and Sander C. (1991)
Database algorithm for generating protein backbone and side-chain co-ordinates from a C alpha trace application to model building and detection of co-ordinate errors.
J. Mol. Biol. 218(1):183-94
PubMed: 2002501
DOI: 10.1016/0022-2836(91)90883-8
 
services/archive/structure/wsmaxsprout.txt · Last modified: 2013/04/23 16:48 by hpm
spacer
spacer