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.

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

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

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

Conversation

stevendavis
Copy link

Very simple 1st pull request, mostly to test the process and make sure everything is setup properly. Added developer instructions to setup rp2 in a conda environment.

@eprbell
Copy link
Owner

eprbell commented Mar 10, 2022

Thanks for the PR! Will add a few comments in the diff.

To setup RP2 in a conda environment, enter the following commands:
```
cd <rp2_directory>
conda create -n <env_name>
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.

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"

@@ -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

Choose a reason for hiding this comment

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

Uppercase Conda

#### Conda virtual environment
To setup RP2 in a conda environment, enter the following commands:
```
cd <rp2_directory>
Copy link
Owner

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.

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
To setup RP2 in a python virtual environment, enter the following commands:
Copy link
Owner

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"

@@ -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

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"

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

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.

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
To setup RP2 in a python virtual environment, enter the following commands:
Copy link
Owner

Choose a reason for hiding this comment

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

Uppercase Python.

Copy link
Owner

@eprbell eprbell left a comment

Choose a reason for hiding this comment

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

Thanks for the PR!

@stevendavis
Copy link
Author

Thinking about this a bit more....
Instead of embedding the Conda instructions within the Windows 10 section, maybe it would make more sense to have a single Conda install section after the list of operating systems, since the commands should be the same for every OS.

@eprbell
Copy link
Owner

eprbell commented Mar 11, 2022

How about this:

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants