Skip to content

Commit 78afe15

Browse files
committed
Added HBP, MCHBP, Packing Similarity and updated ReadMe NO_JIRA
1 parent 359bcde commit 78afe15

15 files changed

+1455
-2
lines changed

.gitignore

+3
Original file line numberDiff line numberDiff line change
@@ -127,3 +127,6 @@ dmypy.json
127127

128128
# Pyre type checker
129129
.pyre/
130+
131+
# PyCharm
132+
.idea/

README.md

+46-2
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,46 @@
1-
# csd-python-api-scripts
2-
Example scripts using the CSD Python API
1+
<img src="assets/csd-python-api-logo.png" width="250px">
2+
3+
# CSD - Python API Scripts
4+
5+
----
6+
7+
A repository containing scripts that have been created to leverage the toolkit found within
8+
the [CCDC portfolio](https://www.ccdc.cam.ac.uk/solutions/) that are accessible via
9+
the [CSD-Python API ](https://www.ccdc.cam.ac.uk/solutions/csd-core/components/csd-python-api/).
10+
11+
The purpose of this platform is to distribute knowledge and allow for scientific collaborations.
12+
13+
> For all support matters please contact [[email protected].]()
14+
15+
## Content
16+
17+
```graphql
18+
.
19+
├─ assets # Images for documentation
20+
├─ example # Python scripts
21+
├─ LICENSE
22+
└─ README.md
23+
```
24+
25+
26+
## Downloading Scripts
27+
28+
This section will focus on how to download multiple or individual scripts:
29+
30+
### 1. Downloading all scripts
31+
32+
#### TO DO - Add gif of downloading Repo
33+
#### TO DO - write instructions on how to download
34+
35+
36+
### 2. Downloading individual scripts
37+
38+
#### TO DO - Add gif of downloading single file
39+
#### TO DO - write instructions on how to download
40+
41+
42+
## Running scripts through the CSD-Python API Miniconda installed
43+
44+
This requires you to already have the CSD-Python API installed.
45+
46+
##### TODO - Write instructions

assets/csd-python-api-logo.png

13.1 KB
Loading
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# Hydrogen Bond Propensity
2+
3+
----
4+
5+
[Summary]
6+
7+
## Example
8+
9+
\#TODO [Output from script]
10+
11+
## Requirements
12+
\#TODO [List]
13+
14+
## Instructions on running
15+
\#TODO [Example run]
16+
17+
## Author
18+
\#TODO [Add]
Binary file not shown.

0 commit comments

Comments
 (0)