Skip to content

Commit 39f6ca8

Browse files
committed
Voids search Readme update NO_JIRA
1 parent 0e68319 commit 39f6ca8

File tree

1 file changed

+22
-6
lines changed

1 file changed

+22
-6
lines changed

scripts/voids_search/Readme.md

Lines changed: 22 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,33 @@
11
# Void Search
22

3-
Script for searching the structures in the CSD for void properties pre-calculated with PoreAnalyser. Can be run on the command line with:
3+
## Summary
4+
5+
Script for searching the structures in the CSD for void properties pre-calculated with PoreAnalyser. When the script is run from Mercury, it will launch a dialog box with properties to search on, and spaces to fill in queries.
6+
These query boxes accept values like "200-300" or ">5" to constrain the search. A .tsv file is written with the search results, and the table is displayed in the Data Analysis tab; non-Ascii
7+
characters in chemical names will be deleted.
8+
A .gcd file of refcodes in the search results is also written, and read into Mercury
9+
10+
## Requirements
11+
12+
- Requires a minimum of CSD 2025.2
13+
14+
## Licensing Requirements
15+
16+
- CSD-Core or above
17+
18+
## Instructions for use
19+
20+
Can be run on the command line with:
421

522
```python
623
python void_search.py
724
```
825

926
or by launching from the CSD Python API dropdown in Mercury. If Launching from Mercury, put the script, with the accompanying search_result_template.html file, in your /mercury/scripts folder,
10-
or use the options dialog to "Add Location" to where you have saved the script. When the script is run, it will launch a dialog box with properties to search on, and spaces to fill in queries.
11-
These query boxes accept values like "200-300" or ">5" to constrain the search. A .tsv file is written with the search results, and the table is displayed in the Data Analysis tab; non-Ascii
12-
characters in chemical names will be deleted.
13-
A .gcd file of refcodes in the search results is also written, and read into Mercury
27+
or use the options dialog to "Add Location" to where you have saved the script.
1428

1529
## Author
1630

17-
Chris Kingsbury <[email protected]>
31+
Chris Kingsbury <[email protected]> (2025)
32+
33+
For feedback or to report any issues please contact [[email protected]](mailto:[email protected])

0 commit comments

Comments
 (0)