Skip to content

Commit f138e52

Browse files
committed
Updated ReadMe NO_JIRA
1 parent ab3cfb4 commit f138e52

File tree

5 files changed

+14
-25
lines changed

5 files changed

+14
-25
lines changed

scripts/concat_mol2/ReadMe.md

Lines changed: 6 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,18 @@
11
# Concat Mol2
22

3-
----
4-
53
## Summary
64

75
Opens a set of mol2 files in the working directory and creates one concatenated multi-mol2 file.
86
Optionally delete the individual mol2 files other than the new concat.mol2
97

108
## Requirements
119

12-
CSD Python API not required.
13-
Mol2 files must be in the same directory.
10+
- CSD Python API not required.
11+
- Mol2 files must be in the same directory.
1412

1513
## Licensing Requirements
1614

17-
No licence required
15+
No license required.
1816

1917
## Instructions on running
2018

@@ -24,20 +22,18 @@ No licence required
2422

2523
Help output:
2624
```cmd
27-
> python concat_mol2.py -h
28-
25+
python concat_mol2.py -h
2926
usage: concat_mol2.py [-h] [-d]
3027
3128
optional arguments:
3229
-h, --help show this help message and exit
3330
-d, --delete_contributors
3431
Remove contributing individual mol2 files after
3532
concatenation
36-
3733
```
3834

3935
## Author
4036

41-
_
37+
_Peter Galek_ (2014)
4238

43-
> For feedback or to report any issues please contact [support@ccdc.cam.ac.uk](support@ccdc.cam.ac.uk)
39+
> For feedback or to report any issues please contact [support@ccdc.cam.ac.uk](mailto:support@ccdc.cam.ac.uk)

scripts/create_castep_input/ReadMe.md

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,5 @@
11
# Create CASTEP Input
22

3-
----
4-
53
## Summary
64

75
Allows the user to generate a set of CASTEP input files (.cell and .params) for a structure viewed in Mercury.
@@ -16,7 +14,7 @@ Requires user to add script to Mercury interface.
1614

1715
## Licensing Requirements
1816

19-
CSD-Core
17+
- CSD-Core
2018

2119
If you wish to run CASTEP, you will need to acquire a licence for CASTEP, this is not supplied by the CCDC.
2220

@@ -26,14 +24,14 @@ Add script with Folder to Mercury interface (Mercury -> CSD Python API-> Options
2624

2725
![img.png](assets/add_script_location.png)
2826

29-
Select refcode interested in or load structure into Mercury.
27+
Select refcode of interest or load structure into Mercury.
3028

3129
Select script from CSD Python API dropdown.
3230

3331
![img.png](assets/select_script.png)
3432

3533
## Author
3634

37-
_Anthony Reilly_
35+
_Anthony Reilly_ (2016)
3836

39-
> For feedback or to report any issues please contact [support@ccdc.cam.ac.uk](support@ccdc.cam.ac.uk)
37+
> For feedback or to report any issues please contact [support@ccdc.cam.ac.uk](mailto:support@ccdc.cam.ac.uk)

scripts/create_gaussian_input/ReadMe.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,5 @@
11
# Create Gaussian Input
22

3-
----
4-
53
## Summary
64

75
Allows the user to generate a Gaussian input file (.gjf) for a given CSD refcode or .mol2. If you wish to run different keywords the script will need to be changed manually.
@@ -31,6 +29,6 @@ To create an input file for the
3129

3230
## Author
3331

34-
_Andrew Maloney_
32+
_Andrew Maloney_ (2015)
3533

36-
> For feedback or to report any issues please contact [support@ccdc.cam.ac.uk](support@ccdc.cam.ac.uk)
34+
> For feedback or to report any issues please contact [support@ccdc.cam.ac.uk](mailto:support@ccdc.cam.ac.uk)

scripts/create_gaussian_input/create_gaussian_input.py

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,6 @@
1414
This script will generate a generic Gaussian input file
1515
Input: CSD Identifier as a string or .mol2
1616
Output: GJF input file
17-
Author: Andy Maloney 2015
1817
"""
1918

2019
import sys

scripts/new_script_readme_template/ReadMe.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,5 @@
11
# Script Name
22

3-
----
4-
53
## Summary
64

75
\#Description of what the script does
@@ -22,7 +20,7 @@
2220

2321
\#CCDC Licence requirements, e.g. CSD-Core, CSD-Materials, CSD-Enterprise, RP
2422

25-
## Instructions on running
23+
## Instructions on Running
2624

2725
\#Command line usage
2826

@@ -34,4 +32,4 @@
3432

3533
\#Author name and date created
3634

37-
> For feedback or to report any issues please contact [support@ccdc.cam.ac.uk](support@ccdc.cam.ac.uk)
35+
> For feedback or to report any issues please contact [support@ccdc.cam.ac.uk](mailto:support@ccdc.cam.ac.uk)

0 commit comments

Comments
 (0)