Skip to content

Commit e5f39c2

Browse files
committed
Added information and images to the HBP script NO_JIRA
1 parent 41892c2 commit e5f39c2

File tree

5 files changed

+23
-9
lines changed

5 files changed

+23
-9
lines changed

scripts/hydrogen_bond_propensity/ReadMe.md

Lines changed: 23 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -3,33 +3,47 @@
33
Writes a .docx report of a hydrogen bond propensity calculation
44

55
----
6-
[Summary]
6+
Inlucded in the report:
7+
- Hydrogen bond propensity chart.
8+
- Table of Predicted intermolecular hydrogen bond propensities.
9+
- Table of Hydrogen bond coordination likelihood.
10+
- Table of Hydrogen Bond Donor/Acceptor Definitions
11+
- Functional Group Definitions for CSD Substructure Searches
12+
- Search Results
13+
- Number of hits selected per functional group
14+
- Hydrogen Bond Analysis of Training Dataset
15+
- Hydrogen bond donor and acceptor outcomes
716

817
## Example
918

10-
\#TODO [Output from script]
19+
<img src="assets/HXACAN_Report_Screenshot_1.png" width="250px">
20+
<img src="assets/HXACAN_Report_Screenshot_2.png" width="250px">
21+
22+
<img src="assets/HXACAN_Report_Screenshot_3.png" width="250px">
23+
<img src="assets/HXACAN_Report_Screenshot_4.png" width="250px">
1124

1225
## Requirements
1326

14-
```matplotlib, docxtpl```
27+
- ```matplotlib, docxtpl```
1528

1629
- hydrogen_bond_propensity_report.docx
1730
## Licensing Requirements
18-
\#TODO [LIST]
31+
- CSD-Core
1932

2033
## Instructions on running
2134

2235
Using mol2 file
36+
2337
```cmd
24-
activate ccdc
38+
"C:\Program Files\CCDC\Python_API_2022\miniconda\Scripts\activate.bat"
2539
python hydrogen_bond_propensity_report.py structure.mol2
2640
```
2741

2842
Options:
29-
30-
- \- d | --directory - sets the working directory
31-
- \- n | --noopen - Do not automatically open the generated output file.
32-
43+
```
44+
- d | --directory - sets the working directory
45+
- n | --noopen - Do not automatically open the generated output file.
46+
```
3347
## Author
3448

3549
_Andrew Maloney_ - CCDC (2017)
61.7 KB
Loading
22.1 KB
Loading
26.6 KB
Loading
28.4 KB
Loading

0 commit comments

Comments
 (0)