Skip to content

Commit b0a4ccf

Browse files
authored
Merge pull request #1 from ccdc-opensource/tidy-up
Updated README NO_JIRA
2 parents 6b5260d + 7069b25 commit b0a4ccf

File tree

6 files changed

+5
-11
lines changed

6 files changed

+5
-11
lines changed

README.md

Lines changed: 5 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,8 @@
1-
# csd-python-api-tutorials
2-
Python scripts relating to the CSD Python API for virtual workshops, self-guided workshops, videos and educational tutorials.
1+
# CSD Python API Tutorials
32

43
<img src="assets/csd-python-api-logo.png" width="100px">
54

6-
# CSD Python API Scripts
7-
8-
A repository containing scripts that have been created to leverage the toolkit found within
5+
This repository contains Python scripts for virtual workshops, self-guided workshops, videos and educational tutorials. The scripts leverage the toolkit found within
96
the [CCDC portfolio](https://www.ccdc.cam.ac.uk/solutions/) that are accessible via
107
the [CSD Python API](https://www.ccdc.cam.ac.uk/solutions/csd-core/components/csd-python-api/).
118

@@ -19,7 +16,6 @@ The purpose of this platform is to distribute knowledge and allow for scientific
1916
.
2017
├─ assets # Images for documentation
2118
├─ scripts # Python scripts
22-
├─ notebooks # Jupyter notebooks
2319
├─ LICENSE
2420
└─ README.md
2521
```
@@ -45,12 +41,10 @@ Whilst in the main repository window click `Code` and select `Download Zip`:
4541

4642
### 2. Downloading Individual Scripts
4743

48-
Once you've found a script/file you wish to download, click on it. This will show you the content of the file. In the top right of the file click `Raw`.
49-
This will open the content in a tab where you can `Right-Click` in the text and select `"Save As..."`.
50-
51-
You will be asked to in your file explorer where you wish to save the file. Please specify the file extension at this point, by default `.txt` is used (For python scripts `.py` is required.)
44+
Once you've found a script/file you wish to download, click on it. This will show you the content of the file. In the top right of the file click on the download button.
45+
This will open a file explorer. Click `"Save As..."` to save the script.
5246

53-
<img src="assets/single_download.gif" width="500px">
47+
<img src="assets/download_single_script.gif" width="500px">
5448

5549
## Running scripts through the CSD Python API Miniconda installed
5650
This requires you to already have the CSD Python API installed. Activate the environment as described in

assets/download_single_script.gif

1.01 MB
Loading

assets/search.gif

-975 KB
Binary file not shown.

assets/single_download.gif

-610 KB
Binary file not shown.
File renamed without changes.

0 commit comments

Comments
 (0)