annotate modify/ob_addh.xml @ 0:6493d130f018

Uploaded
author bgruening
date Tue, 26 Mar 2013 14:49:44 -0400
parents
children ec87a42dccec
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
6493d130f018 Uploaded
bgruening
parents:
diff changeset
1 <tool id="ob_addh" name="Add hydrogen atoms" version="1.0">
6493d130f018 Uploaded
bgruening
parents:
diff changeset
2 <description>at a certain pH value</description>
6493d130f018 Uploaded
bgruening
parents:
diff changeset
3 <parallelism method="multi" split_inputs="infile" split_mode="to_size" split_size="10000" shared_inputs="" merge_outputs="outfile"></parallelism>
6493d130f018 Uploaded
bgruening
parents:
diff changeset
4 <requirements>
6493d130f018 Uploaded
bgruening
parents:
diff changeset
5 <requirement type="package" version="2.3.2">openbabel</requirement>
6493d130f018 Uploaded
bgruening
parents:
diff changeset
6 </requirements>
6493d130f018 Uploaded
bgruening
parents:
diff changeset
7 <command interpreter="python">
6493d130f018 Uploaded
bgruening
parents:
diff changeset
8 ob_addh.py
6493d130f018 Uploaded
bgruening
parents:
diff changeset
9 -i "${infile}"
6493d130f018 Uploaded
bgruening
parents:
diff changeset
10 --iformat "${infile.ext}"
6493d130f018 Uploaded
bgruening
parents:
diff changeset
11 -o "${outfile}"
6493d130f018 Uploaded
bgruening
parents:
diff changeset
12 $polar
6493d130f018 Uploaded
bgruening
parents:
diff changeset
13 --pH "${pH_value}"
6493d130f018 Uploaded
bgruening
parents:
diff changeset
14 </command>
6493d130f018 Uploaded
bgruening
parents:
diff changeset
15 <inputs>
6493d130f018 Uploaded
bgruening
parents:
diff changeset
16 <param name="infile" type="data" format="sdf,smi,mol,mol2,cml,inchi" label="Select input file"/>
6493d130f018 Uploaded
bgruening
parents:
diff changeset
17 <param name="polar" type="boolean" truevalue="--polar" falsevalue="" label="Add hydrogens to polar atoms only"/>
6493d130f018 Uploaded
bgruening
parents:
diff changeset
18 <param name="pH_value" type="float" size="4" value="7.4" label="Specify pH value"/>
6493d130f018 Uploaded
bgruening
parents:
diff changeset
19 </inputs>
6493d130f018 Uploaded
bgruening
parents:
diff changeset
20 <outputs>
6493d130f018 Uploaded
bgruening
parents:
diff changeset
21 <data format_source="infile" name="outfile" />
6493d130f018 Uploaded
bgruening
parents:
diff changeset
22 </outputs>
6493d130f018 Uploaded
bgruening
parents:
diff changeset
23 <tests>
6493d130f018 Uploaded
bgruening
parents:
diff changeset
24 <test>
6493d130f018 Uploaded
bgruening
parents:
diff changeset
25 <param name="infile" value="CID_2244.can" ftype="smi" />
6493d130f018 Uploaded
bgruening
parents:
diff changeset
26 <param name="polar" value="--polar" />
6493d130f018 Uploaded
bgruening
parents:
diff changeset
27 <param name="pH_value" value="7.4" />
6493d130f018 Uploaded
bgruening
parents:
diff changeset
28 <output name="outfile" file="CID_2244_addh.can" ftype="can" />
6493d130f018 Uploaded
bgruening
parents:
diff changeset
29 </test>
6493d130f018 Uploaded
bgruening
parents:
diff changeset
30 </tests>
6493d130f018 Uploaded
bgruening
parents:
diff changeset
31 <help>
6493d130f018 Uploaded
bgruening
parents:
diff changeset
32
6493d130f018 Uploaded
bgruening
parents:
diff changeset
33 .. class:: infomark
6493d130f018 Uploaded
bgruening
parents:
diff changeset
34
6493d130f018 Uploaded
bgruening
parents:
diff changeset
35 **What does this tool do?**
6493d130f018 Uploaded
bgruening
parents:
diff changeset
36
6493d130f018 Uploaded
bgruening
parents:
diff changeset
37 This tool parses a molecular file and adds hydrogen atoms at a certain pH value.
6493d130f018 Uploaded
bgruening
parents:
diff changeset
38
6493d130f018 Uploaded
bgruening
parents:
diff changeset
39 -----
6493d130f018 Uploaded
bgruening
parents:
diff changeset
40
6493d130f018 Uploaded
bgruening
parents:
diff changeset
41 .. class:: infomark
6493d130f018 Uploaded
bgruening
parents:
diff changeset
42
6493d130f018 Uploaded
bgruening
parents:
diff changeset
43 **Protocol:**
6493d130f018 Uploaded
bgruening
parents:
diff changeset
44
6493d130f018 Uploaded
bgruening
parents:
diff changeset
45 **1.** The hydrogen atoms included in the input molecule are deleted.
6493d130f018 Uploaded
bgruening
parents:
diff changeset
46
6493d130f018 Uploaded
bgruening
parents:
diff changeset
47 **2.** Protonation state is predicted at the target pH and the corresponding hydrogen atoms added accordingly.
6493d130f018 Uploaded
bgruening
parents:
diff changeset
48
6493d130f018 Uploaded
bgruening
parents:
diff changeset
49 **Hint:** to avoid possible crashes, only molecules with >5 heavy atoms are parsed.
6493d130f018 Uploaded
bgruening
parents:
diff changeset
50
6493d130f018 Uploaded
bgruening
parents:
diff changeset
51 -----
6493d130f018 Uploaded
bgruening
parents:
diff changeset
52
6493d130f018 Uploaded
bgruening
parents:
diff changeset
53 .. class:: infomark
6493d130f018 Uploaded
bgruening
parents:
diff changeset
54
6493d130f018 Uploaded
bgruening
parents:
diff changeset
55 **Output:** the output format is the same as the input format. 3D format files are required for this tool.
6493d130f018 Uploaded
bgruening
parents:
diff changeset
56
6493d130f018 Uploaded
bgruening
parents:
diff changeset
57 -----
6493d130f018 Uploaded
bgruening
parents:
diff changeset
58
6493d130f018 Uploaded
bgruening
parents:
diff changeset
59 **This tool uses Pybel:** N. M. O'Boyle, C. Morley and G. R. Hutchison. Pybel: a Python wrapper for the OpenBabel cheminformatics toolkit Chem. Cent. J. 2008, 2, 5.
6493d130f018 Uploaded
bgruening
parents:
diff changeset
60
6493d130f018 Uploaded
bgruening
parents:
diff changeset
61 </help>
6493d130f018 Uploaded
bgruening
parents:
diff changeset
62 </tool>