Skip to content

Added developer instructions to setup rp2 in a conda environment. #12

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

Open
stevendavis wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Added developer instructions to setup rp2 in a conda environment. #12

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
16 changes: 15 additions & 1 deletion README.dev.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,10 @@ virtualenv -p python3 .venv
.venv/bin/pip3 install -r requirements.txt
```
### Setup on Windows 10
First make sure [Python](https://python.org) 3.7 or greater is installed (in the Python installer window be sure to click on "Add Python to PATH"), then open a PowerShell window and enter the following commands:
First make sure [Python](https://python.org) 3.7 or greater is installed (in the Python installer window be sure to click on "Add Python to PATH").

#### Python virtual environment
Copy link
Owner

@eprbell eprbell Mar 10, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This structure (Python vs Conda virtual env) would need to be duplicated in the Linux and Mac sections as well.

To setup RP2 in a python virtual environment, enter the following commands:
Copy link
Owner

@eprbell eprbell Mar 10, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you leave the reference to Powershell? I.e.: "open a PowerShell window and enter the following commands"

Copy link
Owner

@eprbell eprbell Mar 10, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Uppercase Python.

```
python -m pip install virtualenv
```
Expand All @@ -92,6 +95,17 @@ virtualenv -p python .venv
.venv\Scripts\activate.ps1
python -m pip install -r requirements.txt
```

#### Conda virtual environment
To setup RP2 in a conda environment, enter the following commands:
Copy link
Owner

@eprbell eprbell Mar 10, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Uppercase Conda

Copy link
Owner

@eprbell eprbell Mar 10, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you leave the reference to Powershell? I.e.: "open a PowerShell window and enter the following commands"

```
cd <rp2_directory>
Copy link
Owner

@eprbell eprbell Mar 10, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The cd command is needed in the Python virtual environment section as well.

conda create -n <env_name>
Copy link
Owner

@eprbell eprbell Mar 10, 2022 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Are you missing instructions on Conda installation? Not sure about Windows (does Conda get installed by the the Python installer?), but I tried it on Mac and I got "conda: command not found"

conda activate <env_name>
conda install pip
pip install -r requirements.txt
```

### Setup on Other Unix-like Systems
* install python 3.7 or greater
* install pip3
Expand Down