diff --git a/README.md b/README.md index 9c9103d..41e92b7 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,8 @@ -# csd-python-api-tutorials -Python scripts relating to the CSD Python API for virtual workshops, self-guided workshops, videos and educational tutorials. +# CSD Python API Tutorials -# CSD Python API Scripts - -A repository containing scripts that have been created to leverage the toolkit found within +This repository contains Python scripts for virtual workshops, self-guided workshops, videos and educational tutorials. The scripts leverage the toolkit found within the [CCDC portfolio](https://www.ccdc.cam.ac.uk/solutions/) that are accessible via the [CSD Python API](https://www.ccdc.cam.ac.uk/solutions/csd-core/components/csd-python-api/). @@ -19,7 +16,6 @@ The purpose of this platform is to distribute knowledge and allow for scientific . ├─ assets # Images for documentation ├─ scripts # Python scripts -├─ notebooks # Jupyter notebooks ├─ LICENSE └─ README.md ``` @@ -45,12 +41,10 @@ Whilst in the main repository window click `Code` and select `Download Zip`: ### 2. Downloading Individual Scripts -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`. -This will open the content in a tab where you can `Right-Click` in the text and select `"Save As..."`. - -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.) +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. +This will open a file explorer. Click `"Save As..."` to save the script. - + ## Running scripts through the CSD Python API Miniconda installed This requires you to already have the CSD Python API installed. Activate the environment as described in diff --git a/assets/download_single_script.gif b/assets/download_single_script.gif new file mode 100644 index 0000000..eb89084 Binary files /dev/null and b/assets/download_single_script.gif differ diff --git a/assets/search.gif b/assets/search.gif deleted file mode 100644 index 90b3195..0000000 Binary files a/assets/search.gif and /dev/null differ diff --git a/assets/single_download.gif b/assets/single_download.gif deleted file mode 100644 index 20dc864..0000000 Binary files a/assets/single_download.gif and /dev/null differ diff --git a/Disorder_Mogul-MOG-003/ReadMe.md b/scripts/Disorder_Mogul-MOG-003/ReadMe.md similarity index 100% rename from Disorder_Mogul-MOG-003/ReadMe.md rename to scripts/Disorder_Mogul-MOG-003/ReadMe.md diff --git a/Disorder_Mogul-MOG-003/analyse_disorder.py b/scripts/Disorder_Mogul-MOG-003/analyse_disorder.py similarity index 100% rename from Disorder_Mogul-MOG-003/analyse_disorder.py rename to scripts/Disorder_Mogul-MOG-003/analyse_disorder.py