You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: scripts/surface_charge/ReadMe.md
+10-8Lines changed: 10 additions & 8 deletions
Original file line number
Diff line number
Diff line change
@@ -2,21 +2,21 @@
2
2
3
3
## Summary
4
4
5
-
This tool returns the surface charge for a given structure and list of supplied hkl and offsets.
6
-
The script provides a GUI that can be used from Mercury or from the command line.
5
+
This tool returns the surface charge for a given structure and list of supplied hkl and offsets.
6
+
The script provides a GUI that can be used from Mercury or from the command line.
7
7
8
-
The output is a HTML file with a table for all the all selected surfaces and their associated charge, projected surface areas and normalised surface charge.
8
+
The output is a HTML file with a table for all the all selected surfaces and their associated charge, projected surface areas and normalised surface charge.
9
9
10
10
Charges are currently calculated using Gasteiger charges. Further development could be made to use user derived charges. Please let me know if that is something you'd like [amoldovan@ccdc.cam.ac.uk](amoldovan@ccdc.cam.ac.uk).
11
11
12
-
Example Output:
12
+
Example Output:
13
13

14
14
15
-
> **Note** - When comparing charges for structures out of the CSD and from mol2 files the values might be different as the bonding might not be the same. When importing a mol2 the bonding and charges have to be calculated on the fly. Whereas the CSD structures the bonding is pre-assigned.
15
+
> **Note** - When comparing charges for structures out of the CSD and from mol2 files the values might be different as the bonding might not be the same. When importing a mol2 the bonding and charges have to be calculated on the fly. Whereas the CSD structures the bonding is pre-assigned.
16
16
17
17
## Requirements
18
18
19
-
- Requires a minimum of CSD 2022.2
19
+
- Requires a minimum of CSD 2022.2
20
20
21
21
## Licensing Requirements
22
22
@@ -25,18 +25,20 @@ Example Output:
25
25
## Instructions on Running
26
26
27
27
- To Run from command line:
28
+
28
29
```commandline
29
30
# With an activated environment
30
31
> python surface_charge.py
31
32
```
32
-
- To run from mercury:
33
+
34
+
- To run from mercury:
33
35
Add the folder containing the script to your Python API menu. Mercury -> CSD Python API-> Options -> Add Location. Then just select the `surface_charge.py` script from the drop down menu
34
36

35
37

36
38
37
39
Running either from the command line or Mercury you will get the same interface allowing you to select a refcode from the CSD or input a mol2 file directly.
0 commit comments