Skip to content

Commit 32909b1

Browse files
committed
Added basic description of MCHBP NO_JIRA
1 parent 129774b commit 32909b1

File tree

1 file changed

+37
-9
lines changed
  • scripts/multi_component_hydrogen_bond_propensity

1 file changed

+37
-9
lines changed
Lines changed: 37 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,51 @@
11
# Multi-Component Hydrogen Bond Propensity
22

3-
----
4-
5-
[Summary]
3+
## Summary
64

5+
Performs a multi-component Hydrogen bond propensity calculation for a given library of co-formers
76
## Example
87

9-
\#TODO [Output from script]
8+
Individual reports are generated for each coformer stored in indvidual folders. A summary multicomponent report with rankings is also generated.
109

11-
## Requirements
12-
\#TODO [List]
10+
Individual reports include:
11+
12+
- Predicted intermolecular hydrogen bond propensities
13+
- Hydrogen bond coordination likelihood
1314

15+
Summary report includes:
16+
- Chemical Diagram
17+
- Table of ranked components
18+
- Multi-component hydrogen-bond propensity chart
19+
20+
## Requirements
21+
- docxtpl
22+
- multi_component_hydrogen_bond_propensity_report.docx
23+
- multi_component_pair_hbp_report.docx
24+
1425
## Licensing Requirements
15-
\#TODO [LIST]
26+
27+
- CSD-Core
1628

1729
## Instructions on running
18-
\#TODO [Example run]
1930

31+
```cmd
32+
python multi_component_hydrogen_bond_propensity_report.py HXACAN28
33+
```
34+
35+
```cmd
36+
positional arguments:
37+
input_structure Refcode or mol2 file of the component to be screened
38+
39+
optional arguments:
40+
-h, --help show this help message and exit
41+
-d DIRECTORY, --directory DIRECTORY
42+
the working directory for the calculation
43+
-c COFORMER_LIBRARY, --coformer_library COFORMER_LIBRARY
44+
the directory of the desired coformer library
45+
```
46+
47+
The default coformer library is the one supplied with your Mercury install in ```<CSD Install Location>\Mercury\molecular_libraries\ccdc_coformers```
2048
## Author
21-
\#TODO [Add]
49+
_Andrew Maloney_ (CCDC) 2017
2250

2351
> For feedback or to report any issues please contact [support@ccdc.cam.ac.uk](support@ccdc.cam.ac.uk)

0 commit comments

Comments
 (0)