|
1 | 1 | # Multi-Component Hydrogen Bond Propensity |
2 | 2 |
|
3 | | ----- |
4 | | - |
5 | | -[Summary] |
| 3 | +## Summary |
6 | 4 |
|
| 5 | +Performs a multi-component Hydrogen bond propensity calculation for a given library of co-formers |
7 | 6 | ## Example |
8 | 7 |
|
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. |
10 | 9 |
|
11 | | -## Requirements |
12 | | -\#TODO [List] |
| 10 | +Individual reports include: |
| 11 | + |
| 12 | +- Predicted intermolecular hydrogen bond propensities |
| 13 | +- Hydrogen bond coordination likelihood |
13 | 14 |
|
| 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 | + |
14 | 25 | ## Licensing Requirements |
15 | | -\#TODO [LIST] |
| 26 | + |
| 27 | +- CSD-Core |
16 | 28 |
|
17 | 29 | ## Instructions on running |
18 | | -\#TODO [Example run] |
19 | 30 |
|
| 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``` |
20 | 48 | ## Author |
21 | | -\#TODO [Add] |
| 49 | +_Andrew Maloney_ (CCDC) 2017 |
22 | 50 |
|
23 | 51 | > For feedback or to report any issues please contact [support@ccdc.cam.ac.uk](support@ccdc.cam.ac.uk) |
0 commit comments