Updated README NO_JIRA #1
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||||
|---|---|---|---|---|---|---|---|---|
| @@ -1,11 +1,8 @@ | ||||||||
| # CSD Python API Tutorials | ||||||||
|
|
||||||||
| <img src="assets/csd-python-api-logo.png" width="100px"> | ||||||||
|
There was a problem hiding this comment. [markdownlint] reported by reviewdog 🐶 |
||||||||
|
|
||||||||
| 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 | ||||||||
| ├─ LICENSE | ||||||||
| └─ README.md | ||||||||
| ``` | ||||||||
|
|
@@ -50,7 +46,7 @@ This will open the content in a tab where you can `Right-Click` in the text and | |||||||
|
|
||||||||
| 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.) | ||||||||
|
|
||||||||
| <img src="assets/save_script.gif" width="500px"> | ||||||||
|
|
||||||||
| ## Running scripts through the CSD Python API Miniconda installed | ||||||||
|
There was a problem hiding this comment. [markdownlint] reported by reviewdog 🐶 There was a problem hiding this comment. [markdownlint] reported by reviewdog 🐶 There was a problem hiding this comment. [markdownlint-fix] reported by reviewdog 🐶
Suggested change
|
||||||||
| This requires you to already have the CSD Python API installed. Activate the environment as described in | ||||||||
|
|
||||||||
Binary file not shown.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
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]