Skip to content

Commit 07b581b

Browse files
committed
updated all requirements, add troubleshooting tips to contributor guide and environment check
1 parent 5c21500 commit 07b581b

File tree

3 files changed

+16
-2
lines changed

3 files changed

+16
-2
lines changed

docs/bootcamp/iap/environment_check.rst

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -46,11 +46,14 @@ be done *inside* a local copy of the ``environment-check`` repository.
4646
so it is not tracked by ``git``! [KEG: This just involves adding the file 'env' to the ".gitignore' file]
4747

4848
.. note::
49-
If you get get an error message about not having permission to run scripts, you may need to change your execution policy.
50-
On Windows:
49+
If you get an error message about not having permission to run scripts, you may need to change your execution policy.
50+
51+
On Windows:
52+
5153
1. Open PowerShell on administrator mode.
5254
2. Type "set-ExecutionPolicy RemoteSigned" and press Enter.
5355
3. Select "Y" to confirm.
56+
5457
Now you should be able to run scripts.
5558

5659
1. Activate the virtual environment, and install the listed dependencies with ``pip install -r requirements.txt``. [Note: "requirements.txt" can be found in the protocol repo]
@@ -97,6 +100,7 @@ be done *inside* a local copy of the ``environment-check`` repository.
97100
5. Are you sure you installed Sphinx? https://pypi.org/project/Sphinx/
98101
6. Visually confirming the protocols' preview is working is encouraging. Try 'Ctrl+Shift+P' or 'Ctrl+Shift+R'
99102
7. If you get stuck, ask for help!
103+
8. If you can't get Python to run from the terminal, you may not have selected "Add to PATH" when initially installing Python. In that case, reinstall Python and ensure "Add to PATH" is selected. Then restart computer.
100104

101105
Protocols check
102106
---------------

docs/contributor_guide.rst

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -137,6 +137,16 @@ We install all of the necessary build requirements by doing:
137137
138138
From now on, you just need to follow the virtual environment activation step.
139139

140+
.. admonition:: Potential Version Issues
141+
142+
You may run into problems with requirement versions being incompatible with your computer's versions.
143+
In this case, you should delete all version information from requirements (control + f "==.*" and delete).
144+
This will automatically install the most up-to-date versions of the packages. After successful installation, freeze these versions by doing:
145+
146+
.. code-block:: console
147+
148+
$ pip freeze > requirements.txt
149+
140150
141151
Standard workflow
142152
-----------------

requirements.txt

1.12 KB
Binary file not shown.

0 commit comments

Comments
 (0)