Technical Setup

Technical Setup#

This guide walks you through everything you need to prepare your development environment for the course. By the end, you will have:

Python installed
Visual Studio Code (VSCode) installed
AI features (such as GitHub Copilot) disabled
A course folder with a Python virtual environment
Pyquist installed
Your virtual environment registered as a Jupyter kernel
VSCode configured to use your virtual environment
A Jupyter notebook that successfully runs Python code
Assignment 1 downloaded and opened

Important

These setup instructions apply to all assignments, both and . For the subset of open-ended assignments that allow AI tools (starting with Assignment 3 released on Sep 7), see the dedicated AI Setup page.

If you follow these instructions carefully, you should not need to troubleshoot anything else before beginning the course.

Tip

If you’re having any issues with installations, come to OH, email us, or check the FAQ section below.

1. Install Python#

Download the latest stable version of Python from https://www.python.org/downloads/. Choose the correct installer for your operating system.

Windows

Download the Windows installer (.msix).
Run the installer.
When a command prompt window appears, say “y” to add Python to your PATH. This is important!
Answer the remaining prompts to complete the installation (it doesn’t hurt to accept the defaults).
After installation, open Command Prompt and verify the installation:

python --version

If you install using the .msi installer, ensure that you click the “Add Python to PATH” checkbox during installation.

macOS

Download the macOS installer.
Run the installer.
Accept the defaults.
After installation, open Terminal and verify the installation:

python3 --version

Linux

Many Linux distributions already include Python.

Open a terminal and run

python3 --version

If Python is missing, install it using your distribution’s package manager.

Ubuntu/Debian:

sudo apt update
sudo apt install python3 python3-venv python3-pip

Verify installation afterwards:

python3 --version

2. Install Visual Studio Code#

Download VSCode from https://code.visualstudio.com/ and follow their installation steps. Once installation is complete, launch VSCode.

3. Install the Jupyter Extension#

Inside VSCode:

Click the Extensions icon on the left sidebar.
Search for Jupyter.
Install the extension published by Microsoft.

You may also wish to install the Python extension from Microsoft if it is not installed automatically.

4. Disable AI Assistance#

This course is designed for you to write and understand your own code. AI tools can interfere with learning the material, though there are times in this course when it is allowed to use them. We will explicitly tell you when it is allowed to use AI tool, though your default assumption should be that they are not allowed . For now, please disable any AI coding assistants you have installed.

If GitHub Copilot or other AI assistants are installed:

Open the Extensions panel.
Search for GitHub Copilot.
Click the gear icon.
Select Disable.

Make sure the Copilot icon is absent from the bottom right of your VSCode.

If you have another AI coding extension installed (Cursor AI, Codeium, Continue, etc.), disable it as well.

You can always re-enable these extensions after the course if desired.

5. Create a Course Folder (optional, recommended)#

We recommend keeping all your course files in a single directory. For the rest of the guide we will refer to this as the course folder, or ~/Documents/ICM, but you should create it at a convenient location. Open this folder in VSCode using File → Open Folder.

6. Create a Virtual Environment#

Open a terminal inside VSCode and ensure your present working directory is the course folder, as this is where you are expected to keep your virtual environment. You can open a terminal by selecting Terminal → New Terminal.

Windows

python -m venv .venv

macOS/Linux

python3 -m venv .venv

This creates a virtual environment named .venv inside your course folder.

7. Activate the Virtual Environment#

Windows

.venv\Scripts\activate

macOS/Linux

source .venv/bin/activate

You should now see something similar to(.venv) at the beginning of your terminal prompt. Note that VSCode may automatically activate the virtual environment for you when you open a terminal in the future, but it is good to know how to do it manually. You can always deactivate the virtual environment by running deactivate.

8. Install Pyquist#

With the virtual environment activated, install Pyquist:

pip install --upgrade pyquist

Wait for installation to finish.

You can verify it by running

pyquist -v

You should see a version string print out.

Finally, test if pyquist can talk to your computer audio:

python -c "import pyquist as pq; pq.play(pq.Audio.from_file(pq.paths.TEST_SOUND))"

You should hear a sound come out of your speakers or headphones. If not, run pyquist devices and configure your default input/output device. Once configured, run the above command to confirm.

9. Register IPython Kernel#

VSCode needs a Jupyter kernel that points at your virtual environment. Register one so it appears by name in every notebook you open.

With your virtual environment still activated, install ipykernel:

pip install ipykernel

Then register the environment as a kernel named ICM:

python -m ipykernel install --user --name=icm --display-name "ICM"

You only need to do this once. If you ever rebuild your virtual environment, run both commands again.

10. Connect VSCode to Your Virtual Environment#

In VSCode, press Ctrl+Shift+P on Windows/Linux or ⌘+Shift+P on macOS.

Search for

Python: Select Interpreter

Choose the interpreter located inside .venv

It should look something like .venv/bin/python (macOS/Linux) or .venv\Scripts\python.exe (Windows)

11. Create Your First Notebook#

Create a new file named hello.ipynb

To connect it to the kernel you registered, press Select Kernel in the upper-right corner of the notebook, then choose:

Select Another Kernel…
Jupyter Kernel…
ICM

In the first cell, type print("Hello, world!").

Run the cell by clicking the Run All button at the top, pressing the triangle next to the cell, or pressing Ctrl+Enter. If everything is working correctly, you should see the output below the cell.

Finally, test Pyquist in your notebook by creating a new cell:

import pyquist as pq
pq.play(pq.Audio.from_file(pq.paths.TEST_SOUND))

Congratulations! You now have Python, VSCode, Jupyter, and your virtual environment working together.

12. Download Assignment 1#

Open Assignment 1 in a new tab
Download the Assignment 1 ZIP file from the course website.
Drag it into your course folder in VSCode

Open up the terminal

mkdir Assignment1
mv starter.zip Assignment1
cd Assignment1
unzip starter.zip
rm starter.zip

Extract (unzip) it.

Your folder should now look something like

~/Documents/ICM/
    .venv/
    Assignment1/{ICMF26Assignment01.ipynb,answers.txt}
    hello.ipynb

Open the Assignment 1 notebook in VSCode, press Select Kernel, choose the ICM kernel, and you’re ready to begin!

13. (Optional) Install Audacity#

Audacity is a free, open-source audio editor. Nothing in this course requires it, but it is handy for recording, trimming, and inspecting audio files.

Navigate to audacityteam.org
Click Download without MuseHub
Run the installer for your platform

Alternatively, download the installer directly from the latest GitHub release.

Fun fact

Audacity was developed right here at CMU by Roger Dannenberg (the original instructor for this course) and his PhD students in the CMU Computer Music Project.

Technical Setup

Contents

Technical Setup#

1. Install Python#

2. Install Visual Studio Code#

3. Install the Jupyter Extension#

4. Disable AI Assistance#

5. Create a Course Folder (optional, recommended)#

6. Create a Virtual Environment#

7. Activate the Virtual Environment#

8. Install Pyquist#

9. Register IPython Kernel#

10. Connect VSCode to Your Virtual Environment#

11. Create Your First Notebook#

12. Download Assignment 1#

13. (Optional) Install Audacity#

Frequently Asked Questions#