Skip to content
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

Update instructions for activating Python API NO_JIRA #53

Merged
merged 1 commit into from
Mar 27, 2024
Merged

Update instructions for activating Python API NO_JIRA #53

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
9 changes: 5 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,14 +50,15 @@ You will be asked to in your file explorer where you wish to save the file. Plea
<img src="assets/single_download.gif" width="500px">

## Running scripts through the CSD Python API Miniconda installed
This requires you to already have the CSD Python API installed.
This requires you to already have the CSD Python API installed. Activate the environment as described in
[this FAQ on activating the CSD Python API](https://www.ccdc.cam.ac.uk/support-and-resources/support/case/?caseid=6c3ec918-aede-ed11-96a2-00505695c114) then run

Windows:
```cmd
"<CCDC_INSTALL_LOCATION>\CCDC\Python_API_2022\miniconda\Scripts\activate.bat"
python script_example.py
```

in the same command prompt / terminal window.

## Submitting or Modifying Scripts

1. [Create a Fork of the repository](https://docs.github.com/en/get-started/quickstart/contributing-to-projects#forking-a-repository) (A fork is a copy of a repository that you manage. Forks let you make changes to a project without affecting the CSD GitHub repo. You can fetch updates from or submit changes to the CSD GitHub repo with pull requests.)
Expand All @@ -66,4 +67,4 @@ python script_example.py

3. [Create a Pull Request](https://docs.github.com/en/get-started/quickstart/contributing-to-projects#making-a-pull-request) to this repository.

4. Once the code has been reviewed it can be merged into the CSD GitHub repo by someone from the CCDC.
4. Once the code has been reviewed it can be merged into the CSD GitHub repo by someone from the CCDC.