Skip to content

Latest commit

 

History

History
76 lines (57 loc) · 7.89 KB

README.md

File metadata and controls

76 lines (57 loc) · 7.89 KB
Raw

Introduction to virtual environments

Python has a wide array of libraries with different versions and many dependencies that you can install on your computer to aid in your research. What do you do when you want to install a new library with dependencies that would conflict with another library you use? The answer is to define self-contained virtual environments. In this workshop, we will cover why and how to create virtual environments for your Python code development.

Prerequisites: Participants should be familiar with Python at the level of the Python Fundamentals Bootcamp, another introductory Python workshop, or be a self-taught Python coder.

Installation

Prior to the workshop, please install either Anaconda or miniforge (not both) and ensure that you are able to access the installed Python. Below are instructions on how to install either of these. How do you choose which to install?

The Anaconda Distribution is a large all-in-one package for installing Python and conda virtual environments, along with many different IDEs, on your computer. It has many positive aspects, especially for new coders, but it is somewhat slow to load and contains (what I consider to be) a lot of "bloatware". Install Anaconda if:

  • You are new to Python
  • You are not comfortable working from the command line, and prefer point and click applications
  • You want an easy 1-click installation solution
  • You will not use this installation of Python for commercial purposes while at Northwestern

Miniforge is an open-source project that provides a minimal installation of the conda / mamba package manager. It is streamlined and fast, but requires you to work from the command line. Install miniforge (and possibly related software) if:

  • You are an experienced coder
  • You are willing to work (minimally) from the command line
  • You don't want any bloatware
  • You would prefer to use an open-source Python package managment system
  • You may use this Python installation for commercial research

If you are unsure which path to take, you should probably choose the first option and install Anaconda.

Note: The installation instructions below were written in Oct. 2024. It is possible these instructions will need to be modified if you are reading this in the future.

Option 1: Install the Anaconda Distribution

  1. Click here to go to the Anaconda download page.
  2. Agree to their terms and download the installer.
  3. Run the installer on your computer.
  4. Open the Anaconda Navigator application on your computer (has a green circle icon).
  5. Within the Navigator, click on the Jupyter Notebook (or Jupyter Lab) icon.
  6. In the notebook that launches, create a code cell and type 1+1 and then Shift + Enter (or Shift + Return) to exectute that cell. If it returns 2 without any errors, then you have successfully installed Anaconda's Python, and you are ready to attend the workshop.

Option 2: Install miniforge (and possibly other software)

  1. Click here to go to the miniforge GitHub repo. Download the installer for your operating system, and run the installer on your computer. Accept all the defaults.
  2. If you are on Windows, I recommend that you also install Git Bash (or work in WSL). Click here to go to the Git Bash website. Download the installer, and run the installer on your computer. Accept all the defaults. (If you are working on a Mac or Linux, you already have Bash installed.)
  3. The first time you use conda (or mamba) you will need to initialize it within your terminal. You only need to do this step once. To initialize, open your terminal and type : 
    ~/miniforge3/Scripts/mamba.exe init bash
    (If you chose a non-standard installation path for miniforge, you may need to modify the command above to point to the proper file.) This will edit your .bash_profile (or .bashrc) file to initialize conda and mamba when you open a terminal. (These files are read each time your terminal is initialized, and can be used to set different environmental variables and perform other operations.) Close this terminal (e.g., type exit). Then every new terminal you open will have access to conda, mamba and the related python.
  4. Within your terminal, create your first python virtual environment by typing: 
    mamba create --name test-env python=3.12 jupyter
    (and confirming that you do want to install the packages.)
  5. To activate this environment, type the following in your terminal: 
    mamba activate test-env
  6. Open a Jupyter notebook to test the installation, but typing the following into your terminal 
    jupyter notebook
    This should launch a browser that hosts Jupyter and shows a list of the files in your current working directory. Click the "New" button in the upper-right to create a new Python 3 notebook. Within a code cell, type 1+1 and then Shift + Enter (or Shift + Return) to exectute that cell. If it returns 2 without any errors, then you have successfully installed Python, and you are ready to attend the workshop.

Option 2+: Also install VS Code

I personally prefer to work within VS Code for all my code development. This is a very flexibly IDE with many extensions and great integration with GitHub. If you are interested in installing and using VS Code, you can follow these steps after completing the "Option 2" installation instructions above.

  1. Click here to go to the VS Code website. Download the installer, and run the installer on your computer. Accept all the defaults.
  2. Open VS Code, and set the default terminal by typing Ctrl + Shift + p then searching in the top bar for Terminal: Select Default Profile. For Windows users, select Git Bash. Otherwise, select your default bash terminal for your OS.The shortcut to open a terminal window (in the bottom portion of VS Code) is Ctrl + ~. You can use this terminal to create, activate, deactivate (etc.) virtual environments, as explained above.
  3. On the left panel of VS Code, click on the top icon for the Explorer. Then click Open Folder. This should bring up a finder window allowing you to select (or create) a folder for code development. Select a folder. This should show all the files and sub-directories from that folder within the left side bar of VS Code.
  4. To create a new file, place your mouse within that left side bar to reveal the tools at the top that allow you to create new folders and files. (Alternatively, you can right-click in that side panel to open a menu.) As a test, create a new file named test.ipynb. Then click on that new file to open it (if it doesn't open automatically) in the main window of VS Code.
  5. Within the test.ipynb portion of the VS Code window, click on Select Kernel (in upper right). This may cause VS Code to ask you to install the Jupyter and Python extensions; install those as requested. (You would only need to install these extensions once.) After those extensions are installed (and after clicking on Select Kernel), you should see the option at the top panel for Python Environments. Click on that, and then select your test-env (assuming you followed the instructions above to create that env).
  6. Within your test.ipynb file, create a code cell and type 1+1 and then Shift + Enter (or Shift + Return) to exectute that cell. If it returns 2 without any errors, then you have successfully installed Python and conda/mamba, and you are ready to attend the workshop.

Getting Help

If you have any trouble with the installation steps above, please use this link to submit a consultation request. Someone on our team will be happy to help you!