{"id":29301,"date":"2023-01-30T13:38:46","date_gmt":"2023-01-30T13:38:46","guid":{"rendered":"https:\/\/www.process.st\/templates\/how-to-setup-a-jupyter-notebook-in-vs-code-virtual-env-kernels\/"},"modified":"2024-06-18T13:39:48","modified_gmt":"2024-06-18T13:39:48","slug":"how-to-setup-a-jupyter-notebook-in-vs-code-virtual-env-kernels","status":"publish","type":"post","link":"https:\/\/www.process.st\/templates\/how-to-setup-a-jupyter-notebook-in-vs-code-virtual-env-kernels\/","title":{"rendered":"How To Setup a Jupyter Notebook in VS Code (Virtual Env + Kernels)"},"content":{"rendered":"
\n

\u200d Overview<\/h2>\n
\n

HOW TO SETUP JUPYTER NOTEBOOK IN VS CODE (W\/ VIRTUAL ENV & KERNELS)<\/strong><\/h3>\n<\/p><\/div>\n
\n

Figuring out how to how setup a jupyter notebook<\/code> is pretty easy \u2013 you just open your terminal, install jupyter & run jupyter notebook<\/code>.<\/p>\n

But figuring out how to do it inside of VS CODE was not very intuitive (at least not for me, as I am kind of a newb with python).<\/p>\n

But learning from newbies is the best thing you can do because, as you will find out, we are so \u201cdumb\u201d that our processes need to be so detailed that a monkey could run them, so it\u2019s unlikely we will leave out some critical step that just ruins your whole day.<\/p>\n

So here is my process, compiled from digging, reading, and banging my head against a wall until i nailed it.<\/p>\n

Let\u2019s get to it.<\/p>\n<\/p><\/div>\n

\n
\n<\/p><\/div>\n
\n

Prerequisites<\/strong><\/h4>\n
Install jupyter<\/strong><\/h5>\n

First, you obviously need jupyter installed.<\/p>\n

If you haven\u2019t done that, then do that first.<\/p>\n

Not going to cover that here because i don\u2019t know what system you\u2019re on, or package manager you use.<\/p>\n

Onwards.<\/p>\n

VS Code jupyter extensions<\/strong><\/h5>\n

i don\u2019t know enough about extensions to recommend \u201cthe perfect setup\u201d, but here\u2019s what I have installed.<\/p>\n

so if you feel like just being a lemming and following my lead, here ya go:<\/p>\n

    \n
  1. Jupyter (extension ID: ms-toolsai.jupyter<\/code>)<\/li>\n
  2. Jupyter Notebook Renderers (extension ID: ms-toolsai.jupyter-renderers<\/code>)<\/li>\n
  3. Jupyter Keymap (extension ID: ms-toolsai.jupyter-keymap<\/code>)<\/li>\n
  4. VS Code Jupyter Notebook Previewer (extension ID: jithurjacob.nbpreviewer<\/code>)<\/li>\n<\/ol><\/div>\n
    \n
    Step 1. Create project folder<\/strong><\/h5>\n

    First you need a project folder, so create that.<\/p>\n

    You can use Finder, Terminal, or do it in VS Code.<\/p>\n

    I like doing it without the GUI because \u201cpractice makes progress\u201d.<\/p>\n

    Tweet that. You\u2019ll look clever & sophisticated.<\/p>\n

    And then get back to work because you aren\u2019t here to be dickin\u2019 around on social media.<\/p>\n

    Create your project folder:<\/p>\n

    # syntax\nmkdir <folder name>\n\n\n# example\nmkdir myproject<\/pre>\n
    Step 2. Create, activate & select your virtual environment<\/strong><\/h5>\n
    Navigate to \/ open your project folder and create a virtual environment inside of it:<\/p>\n
    # syntax\npython3 -m venv <virtual environment name>\n\n# example\n# that would create a virtual environment named 'myenv'\npython3 -m venv myenv<\/pre>\n
    Now activate the virtual environment and when VS CODE prompts you to set it as default for the project, hit yes.<\/p>\n
    # syntax\nsource <virtual environment name>\/bin\/activate\n\n# example\nsource myenv\/bin\/activate<\/pre>\n
    Step 3. Install ipykernel<\/code><\/strong><\/h5>\n
    Now that your virtual environment is activated, install ipykernel<\/code><\/p>\n
    pip3 install ipykernel<\/pre>\n
    Step 4. Create new kernel<\/h5>\n
    Now you can create a new kernel to be used for your project:<\/p>\n
    # syntax\npython3 -m ipykernel install --user --name=<projectname>\n\n\n# example\n# That would create a kernel named 'myproject'\npython3 -m ipykernel install --user --name=myproject<\/pre>\n
    Step 5. Start jupyter<\/h5>\n
    Now you can start Jupyter. I do it from the VS Code terminal.<\/p>\n
    jupyter notebook<\/pre>\n
    If you did this right you should see something like this in your terminal:<\/p>\n
    To access the notebook, open this file in a browser:\n        file:\/\/\/Users\/<your username>\/Library\/Jupyter\/runtime\/nbserver-15044-open.html\n    Or copy and paste one of these URLs:\n        https:\/\/localhost:8889\/?token=f1ae910e56381c26a62cfb18f83241076bd11d84f7e8e36e\n     or https:\/\/127.0.0.1:8889\/?token=f1ae910e56381c26a62cfb18f83241076bd11d84f7e8e36e<\/pre>\n
    Step 6. Select kernel for project<\/strong><\/h5>\n
    Now you can assign the kernel to the project in VS CODE.<\/p>\n
    Step 6.1: Create a new Jupyter notebook<\/strong><\/p>\n