Skip to content

Latest commit

 

History

History
101 lines (68 loc) · 5.1 KB

README.md

File metadata and controls

101 lines (68 loc) · 5.1 KB
Raw

NEU502b lab code

Jupyter notebooks and materials for in-class lab demonstrations and exercises.

Setting up your computing environment

We recommend setting up a dedicated computing environment for this class using conda. You can set up this conda environment locally or on the PNI server (i.e. scotty). To log onto the PNI server, connect to the Princeton VPN and use ssh from the command line with your username/password; e.g. ssh [email protected] (let the instructor know if you've never done this before). In the first step, we'll install miniconda in your home directory. If you already have a working conda installation, you can skip this step.

If you're on a Windows machine, use PowerShell, Cygwin, PuTTY, or Windows Subsystem for Linux to log onto the PNI server, then proceed to the following Linux instructions.

If you're on a Linux machine (e.g. the PNI server), use the following:

cd ~
wget https://repo.anaconda.com/miniconda/Miniconda3-latest-Linux-x86_64.sh
bash Miniconda3-latest-Linux-x86_64.sh

If you're on a Mac, use the following instead:

cd ~
curl https://repo.anaconda.com/miniconda/Miniconda3-latest-MacOSX-x86_64.sh -o Miniconda3-latest-MacOSX-x86_64.sh
bash Miniconda3-latest-MacOSX-x86_64.sh

Next, we'll create a conda environment for the class and activate that environment.

conda create --name neu502b
conda activate neu502b

Now we'll install some necessary packages (and their dependencies) into our conda environment.

conda install jupyterlab scipy git matplotlib seaborn
conda install -c conda-forge gh

Later in the course, we'll install some additional packages (but don't worry about this for now); for example:

pip install nilearn
conda install -c conda-forge mne-base
conda install pytorch

Create a GitHub account at https://github.com if you don't already have one. Next, in the terminal configure git with a username and email.

git config --global user.name "Your Name"
git config --global user.email "[email protected]"

Begin authenticating with GitHub from git.

gh auth login

Select GitHub.com, HTTPS, Yes and Paste an authentication token. Then, navigate to https://github.com/settings/tokens in a browser. Click Generate new token and enter a nickname of your computer in the Note field (e.g. macbook, scotty). Set the expiration to No expiration. Click repo, read:org, and user; then, click Generate token. Copy the token and paste it into Paste your authentication token on the command line.

Forking and cloning the repository

On the GitHub repository page (https://github.com/NEU502B/neu502b-2024), click the Fork button at top right. Click Create fork to create a copy of the repository on your own GitHub account.

Back to the terminal: If you don't already have a directory for this class, make one (mkdir neu502b) and navigate into it (cd neu502b).

Now, you'll clone your own fork of the repository (specify your GitHub username below) into your class directory:

git clone https://github.com/username/neu502b-2024
cd neu502b-2024

Running the notebooks

You can download and run the notebooks on your local computer, on the PNI server, or run them on the cloud using Colab. To run the notebooks locally, navigate your terminal to your neu502b directory and run jupyter lab.

To run the notebooks on the server, we'll use port forwarding with an SSH tunnel to render the remote notebook in your local browser. First, log onto the server (e.g. ssh [email protected]). We recommend starting a persistent tmux session on the server (you can learn more about tmux here):

tmux new -s neu502b

You'll need to (re)activate the conda environment again inside the tmux session. Now, we'll start running Jupyter in the tmux session on the remote server (without a browser):

jupyter lab --no-browser

Next, copy the full URL output by the jupyter lab command on the server (including the authentication token); e.g. http://localhost:8888/?token=abcdefghijklmnopqrstuv0123456789abcdefghijklmnop

Now, open a local terminal and set up an SSH tunnel using the remote port (8888 in the above example):

ssh -NL 8888:localhost:8888 [email protected]

Finally, open a browser and copy the full URL output by the jupyter lab command into the browser's URL bar. This should render the remote Jupyter session in your local browser, allowing you to efficiently interact with notebooks on the server.

This workflow follows best practices described in the Princeton Handbook for Reproducible Neuroimaging, and more details as well as other useful tips can be found there.