Skip to content

Commit c6f0335

Browse files
committed
Added Readme for surface charge script SCI-1396
1 parent 7cffd87 commit c6f0335

File tree

6 files changed

+46
-0
lines changed

6 files changed

+46
-0
lines changed

scripts/surface_charge/ReadMe.md

+46
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
# Surface Charge Calculator
2+
3+
## Summary
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.
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.
9+
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 [[email protected]]([email protected]).
11+
12+
Example Output:
13+
![Example Output](assets/example_output.png)
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.
16+
17+
## Requirements
18+
19+
- Requires a minimum of CSD 2022.2
20+
21+
## Licensing Requirements
22+
23+
- CSD-Particle Licence
24+
25+
## Instructions on Running
26+
27+
- To Run from command line:
28+
```commandline
29+
# With an activated environment
30+
> python surface_charge.py
31+
```
32+
- To run from mercury:
33+
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+
![Adding_Locations](assets/adding_location.png)
35+
![Selecting Scripts](assets/selecting_script.png)
36+
37+
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.
38+
39+
Example input :
40+
![Example Input](assets/example_input.png)
41+
42+
## Author
43+
44+
Alex Moldovan (2024)
45+
46+
> For feedback or to report any issues please contact [[email protected]](mailto:[email protected])
Loading
Loading
12.5 KB
Loading
36.1 KB
Loading
Loading

0 commit comments

Comments
 (0)