Skip to content

Commit 97a5edc

Browse files
committed
basic Readme added NO_JIRA
1 parent e6b697c commit 97a5edc

File tree

1 file changed

+17
-0
lines changed

1 file changed

+17
-0
lines changed

scripts/voids_search/Readme.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# Void Search
2+
3+
Script for searching the structures in the CSD for void properties pre-calculated with PoreAnalyser. Can be run on the command line with:
4+
5+
```python
6+
python void_search.py
7+
```
8+
9+
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 dailog 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
14+
15+
## Author
16+
17+
Chris Kingsbury <[email protected]>

0 commit comments

Comments
 (0)