Skip to content

Commit b0b231c

Browse files
committed
correct for ridiculous reviewdog line complaints (NO_JIRA)
1 parent d778a1e commit b0b231c

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

scripts/refcodes_with_properties/ReadMe.md

+8
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,34 @@
11
# Refcode List Generator
22

3+
34
## Summary
45

56
A script that allows you to create refcode lists (or CSV files of properties for a refcode list) for simple properties. The advantage of the script is
67
that the control is via an easy to read file so you can keep an interprettable record of how a test set was generated in research. You can also then
78
reproduce the list, or indeed run it on a new database and update it with the same conditions.
89

10+
911
### Relevance
1012

1113
We want research to be FAIR (Findable, Attributable, Interoperable and Reproducible) - this script means we can create a simple decscription of the
1214
test set used that any researcher could then reproduce from the script and the description.
1315

16+
1417
## Requirements
1518

1619
- Tested with CSD Python API version 3.9 on Linux and Windows
1720
- ccdc.io
1821
- ccdc.search
1922

23+
2024
## Licensing Requirements
2125

2226
- CSD-Core
2327

28+
2429
## Instructions on Running
2530

31+
2632
### Linux command line
2733

2834
- load the CSD Python API Miniconda environment
@@ -41,13 +47,15 @@ $ python refcodes_with_properties.py -c example_control_file.txt -o mylist.gcd
4147
~~~
4248
This will generate a GCD file that can be used in other work.
4349

50+
4451
### Windows CSD Python API
4552
- launch a CMD window
4653
- Use the installed version of the CSD Python API, for example C:\Users\<YOUR WINDOWS USERNAME>\CCDC\ccdc-software\csd-python-api assuming the CCDC tools are installed in the ususal place do this
4754
~~~
4855
C:\Users\<YOUR WINDOWS USERNAME>\CCDC\ccdc-software\csd-python-api\run_python_api.bat refcodes_with_properties.py --help
4956
~~~
5057

58+
5159
## Author
5260

5361
_Jason C.Cole_ 2025

0 commit comments

Comments
 (0)