Skip to content

Updated README NO_JIRA #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Oct 3, 2025
Merged

Updated README NO_JIRA #1

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
133920b
Updated README NO_JIRA
apeel-ccdc Oct 2, 2025
40ce9b6
Tidied Files NO_JIRA
apeel-ccdc Oct 2, 2025
7a547d4
Update GIF NO_JIRA
apeel-ccdc Oct 2, 2025
7069b25
update readme download NO_JIRA
apeel-ccdc Oct 3, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 5 additions & 11 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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

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

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[markdownlint] reported by reviewdog 🐶
MD033/no-inline-html Inline HTML [Element: img]

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[markdownlint] reported by reviewdog 🐶
MD045/no-alt-text Images should have alternate text (alt text)


# 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/).

Expand All @@ -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
```
Expand All @@ -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.
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[markdownlint] reported by reviewdog 🐶
MD009/no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 1]

This will open a file explorer. Click `"Save As..."` to save the script.
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[markdownlint] reported by reviewdog 🐶
MD009/no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 1]

Comment on lines +44 to +45
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[markdownlint-fix] reported by reviewdog 🐶

Suggested change
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.
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.


<img src="assets/single_download.gif" width="500px">
<img src="assets/download_single_script.gif" width="500px">
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[markdownlint] reported by reviewdog 🐶
MD033/no-inline-html Inline HTML [Element: img]

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[markdownlint] reported by reviewdog 🐶
MD045/no-alt-text Images should have alternate text (alt text)


## Running scripts through the CSD Python API Miniconda installed
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[markdownlint] reported by reviewdog 🐶
MD009/no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 1]

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[markdownlint] reported by reviewdog 🐶
MD022/blanks-around-headings Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Below] [Context: "## Running scripts through the CSD Python API Miniconda installed"]

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[markdownlint-fix] reported by reviewdog 🐶

Suggested change
## Running scripts through the CSD Python API Miniconda installed
## 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
Expand Down
Binary file added assets/download_single_script.gif
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed assets/search.gif
View file
Open in desktop
Binary file not shown.
Binary file removed assets/single_download.gif
View file
Open in desktop
Binary file not shown.
0 Disorder_Mogul-MOG-003/ReadMe.md → scripts/Disorder_Mogul-MOG-003/ReadMe.md
View file
Open in desktop
File renamed without changes.
0 Disorder_Mogul-MOG-003/analyse_disorder.py → ...isorder_Mogul-MOG-003/analyse_disorder.py
View file
Open in desktop
File renamed without changes.