Skip to content

Commit 9054c55

Browse files
committed
SCI-1396 reviewed and modified .md file
1 parent 1d51751 commit 9054c55

File tree

1 file changed

+10
-8
lines changed

1 file changed

+10
-8
lines changed

scripts/surface_charge/ReadMe.md

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,17 +2,18 @@
22

33
## Summary
44

5-
This tool returns the surface charge for a given structure and list of supplied hkl and offsets.
5+
This tool returns the total surface charges for a given structure and list of supplied hkl indices and offsets.
66
The script provides a GUI that can be used from Mercury or from the command line.
77

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 an HTML file with a table for all the selected surfaces and their associated charges, projected surface areas, and normalised surface charges (surface charge per projected area).
99

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).
10+
Charges are currently calculated using the Gasteiger charge model. Further development could be made to use user derived charges. Please let us know if that is of interest: [support@ccdc.cam.ac.uk](support@ccdc.cam.ac.uk).
1111

1212
Example Output:
13+
1314
![Example Output](assets/example_output.png)
1415

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+
> **Note** - When comparing charges for non-CSD structures and structures from mol2 files the values might be different as the bonding might not be the same. When importing a mol2 file the bonding and charges may have to be calculated on the fly, whereas this information is assigned for CSD entries.
1617
1718
## Requirements
1819

@@ -22,7 +23,7 @@ Example Output:
2223

2324
- CSD-Particle Licence
2425

25-
## Instructions on Running
26+
## Instructions for use
2627

2728
- To Run from command line:
2829

@@ -32,13 +33,14 @@ Example Output:
3233
```
3334

3435
- To run from mercury:
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
36+
Add the folder containing the script to your Python API menu. Mercury -> CSD Python API-> Options -> Add Location. Then select the `surface_charge.py` script from the drop down menu
3637
![Adding_Locations](assets/adding_location.png)
3738
![Selecting Scripts](assets/selecting_script.png)
3839

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.
40+
Running from either the command line or Mercury will show the same interface allowing you to select a refcode from the CSD or input a mol2 file directly.
41+
42+
Example Input:
4043

41-
Example input :
4244
![Example Input](assets/example_input.png)
4345

4446
## Author

0 commit comments

Comments
 (0)