-
Notifications
You must be signed in to change notification settings - Fork 4
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
Add detailed steps on how to create and add conda environments to jupyter notebook #198
Open
DeclanGazil02
wants to merge
5
commits into
ncsu-landscape-dynamics:main
Choose a base branch
from
DeclanGazil02:conda-env-docs
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
f867159
Added detailed steps on how to create and add your conda environments…
DeclanGazil02 6e62035
Fixed typo.
DeclanGazil02 459a43b
Fixed spacing.
DeclanGazil02 4cc84e2
Made changes mentioned in pull request comments. Followed conventiona…
DeclanGazil02 5e27096
Changed pip statements to conda and reduced statements by adding pipe…
DeclanGazil02 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -17,3 +17,67 @@ conda deactivate | |
``` | ||
|
||
To use your environment, run the command "conda activate popsborder_env" or select the popsborder_env environment from your IDE (e.g. VS Code, Atom, PyCharm). | ||
|
||
## Adding Conda Environments to Jupyter Notebook | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Delete this section and incorporate additions into section above. |
||
|
||
Conda allows you to create isolated environments with specific versions of Python and its packages. | ||
This prevents conflicts between | ||
different projects' dependencies. | ||
|
||
### Step 1: Create your conda environment | ||
Inside of your conda based command line navigate inside your forked PopsBorder | ||
folder. Next use the following command | ||
```bat | ||
conda create -n PopsBorderEnv python=3.8 | ||
``` | ||
This creates your environment with python version 3.8. | ||
PopsBorderEnv is the name of your environment. Change as needed. | ||
|
||
### Step 2: Activate your environment | ||
Using your newly created environment from the previous step, run | ||
```bat | ||
conda activate PopsBorderEnv | ||
``` | ||
Now you have entered into your environment. | ||
|
||
### Step 3: Install pipenv into you environment | ||
Now install pipenv into your environment, a packaging tool we utilize | ||
for our project. | ||
```bat | ||
conda install pipenv | ||
``` | ||
|
||
### Step 4: Install dependencies using pipenv | ||
To download dependencies and create a virtual environment from the Pipfile.lock use: | ||
```bat | ||
pipenv install | ||
``` | ||
|
||
### Step 5: Install your jupyter notebook in your Virtual Environment | ||
Run the command below to install the necessary python kernel. | ||
```bat | ||
pipenv run conda install ipykernel | ||
``` | ||
Next Run the following command replacing PopsBorderEnv with your | ||
environment name: | ||
```bat | ||
pipenv run python -m ipykernel install --user --name=PopsBorderEnv | ||
``` | ||
This installs a jupyter kernel in your environment, allowing you to | ||
use your kernel in Jupyter Notebook. | ||
|
||
### Step 6: Open Jupyter Notebook | ||
Run from within your environment | ||
```bat | ||
pipenv run jupyter notebook | ||
``` | ||
This will open jupyter notebook in your default browser or provide | ||
a url in the terminal. You now have your environment linked to | ||
jupyter notebook. | ||
|
||
### Step 7: Select the correct kernel | ||
Navigate into the notebook file you want to run, denoted by .ipynb. | ||
Examples can be found in the /examples/notebooks folder. | ||
Click on the Kernel tab, then the "Change Kernel" tab and select your | ||
created environment, in this case ours is "PopsBorderEnv". | ||
Now you can run the notebook files. |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Add new lines for installing ipykernel and adding the env to Jupyter to the code chunk at line 16.