Skip to content

Commit 3be3593

Browse files
authored
Merge pull request #53 from ccdc-opensource/emyers-ccdc-update-readme
Update instructions for activating Python API NO_JIRA
2 parents 33ad7cc + 8b44878 commit 3be3593

File tree

1 file changed

+5
-4
lines changed

1 file changed

+5
-4
lines changed

README.md

+5-4
Original file line numberDiff line numberDiff line change
@@ -50,14 +50,15 @@ You will be asked to in your file explorer where you wish to save the file. Plea
5050
<img src="assets/single_download.gif" width="500px">
5151

5252
## Running scripts through the CSD Python API Miniconda installed
53-
This requires you to already have the CSD Python API installed.
53+
This requires you to already have the CSD Python API installed. Activate the environment as described in
54+
[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
5455

55-
Windows:
5656
```cmd
57-
"<CCDC_INSTALL_LOCATION>\CCDC\Python_API_2022\miniconda\Scripts\activate.bat"
5857
python script_example.py
5958
```
6059

60+
in the same command prompt / terminal window.
61+
6162
## Submitting or Modifying Scripts
6263

6364
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.)
@@ -66,4 +67,4 @@ python script_example.py
6667

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

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

0 commit comments

Comments
 (0)