MotiveValidator:Technical details: Difference between revisions
Created page with "This is help for version 0.1.13.11.22d. The help text for other versions be viewed using the --help command when running the application. === Running the Service === The servi..." |
No edit summary |
||
| Line 1: | Line 1: | ||
This is help for version 0.1.13.11.22d. The help text for other versions be viewed using the --help command when running the application. | This is help for version 0.1.13.11.22d. The help text for other versions be viewed using the --help command when running the application. | ||
== Running the Service == | |||
The service can be executed using the command (latest .NET Framework required): | The service can be executed using the command (latest .NET Framework required): | ||
<pre>WebChemistry.MotiveValidator.Service.exe configuration.json resultFolder</pre> | <pre>WebChemistry.MotiveValidator.Service.exe configuration.json resultFolder</pre> | ||
| Line 6: | Line 6: | ||
<pre>mono WebChemistry.MotiveValidator.Service.exe configuration.json resultFolder</pre> | <pre>mono WebChemistry.MotiveValidator.Service.exe configuration.json resultFolder</pre> | ||
== Configuration == | |||
The configuration is specified using the JSON format. | The configuration is specified using the JSON format. | ||
=== Configuration Example === | |||
This is the general shape of the input configuration. More examples are included with the application distribution. | This is the general shape of the input configuration. More examples are included with the application distribution. | ||
<pre>{ | <pre>{ | ||
| Line 19: | Line 19: | ||
}</pre> | }</pre> | ||
=== Attributes === | |||
* '''ValidationType''' [ [[#MotiveValidationType_details|MotiveValidationType]] ], Default value = "Model" | * '''ValidationType''' [ [[#MotiveValidationType_details|MotiveValidationType]] ], Default value = "Model" | ||
: ''Type of the validation.'' | : ''Type of the validation.'' | ||
| Line 35: | Line 35: | ||
: ''Determines whether to compute only the summary file and not files with motifs.'' | : ''Determines whether to compute only the summary file and not files with motifs.'' | ||
=== Descriptions === | |||
===== <span id='MotiveValidationType_details'>MotiveValidationType</span> ===== | ===== <span id='MotiveValidationType_details'>MotiveValidationType</span> ===== | ||
* '''Model''' | * '''Model''' | ||
| Line 49: | Line 49: | ||
: ''Special mode for Web UI, use Residues instead.'' | : ''Special mode for Web UI, use Residues instead.'' | ||
== Output Description == | |||
TODO | TODO | ||
Revision as of 01:30, 23 November 2013
This is help for version 0.1.13.11.22d. The help text for other versions be viewed using the --help command when running the application.
Running the Service
The service can be executed using the command (latest .NET Framework required):
WebChemistry.MotiveValidator.Service.exe configuration.json resultFolder
In Linux (where available) and MacOS, the latest version the Mono Framework (http://mono-project.com/) must be used to run the application:
mono WebChemistry.MotiveValidator.Service.exe configuration.json resultFolder
Configuration
The configuration is specified using the JSON format.
Configuration Example
This is the general shape of the input configuration. More examples are included with the application distribution.
{
"ValidationType": "Model",
"InputFolder": "./MAN",
"ModelFilename": "./MAN.pdb",
"ModelsFolder": "./Models",
"SummaryOnly": false
}
Attributes
- ValidationType [ MotiveValidationType ], Default value = "Model"
- Type of the validation.
- InputFolder [ String ]
- Folder with the input data.
- ModelFilename [ String ]
- Filename of the model.
- ModelsFolder [ String ]
- Folder with models in PDB format.
- SummaryOnly [ Boolean ], Default value = false
- Determines whether to compute only the summary file and not files with motifs.
Descriptions
MotiveValidationType
- Model
- Analyzes the input biomolecule fragments (motifs) against the provided model using the ModelFilename attribute.
- Sugars
- Automatically identifies and analyzes sugars inside the input biomolecules (with models from the ModelsFolder attribute).
- Residues
- Automatically identifies and all residue inside the input biomolecules (with models from the ModelsFolder attribute).
- CustomModels
- Special mode for Web UI, use Residues instead.
Output Description
TODO