From 8b448784f36378a2b38eae88f296220476f39b8d Mon Sep 17 00:00:00 2001
From: Eva Myers <81232948+emyers-ccdc@users.noreply.github.com>
Date: Tue, 26 Mar 2024 15:24:47 +0000
Subject: [PATCH] Update instructions for activating Python API NO_JIRA
---
README.md | 9 +++++----
1 file changed, 5 insertions(+), 4 deletions(-)
diff --git a/README.md b/README.md
index 0a42692..37b4a9c 100644
--- a/README.md
+++ b/README.md
@@ -50,14 +50,15 @@ You will be asked to in your file explorer where you wish to save the file. Plea
## 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\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.)
@@ -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.
\ No newline at end of file
+4. Once the code has been reviewed it can be merged into the CSD GitHub repo by someone from the CCDC.