📝

VSCode で Jupyter Notebook の開発環境を構築する手順

2024/05/19に公開

Python

VS Code

jupyter

tech

はじめに

VSCode で Jupyter Notebook の開発環境を構築したので、その時の手順を備忘録として残します。
これから Jupyter Notebook の開発環境を構築する方に参考になれば幸いです。

前提

VSCode はインストール済みであること

必要なもの

VSCode (Visual Studio Code) - 事前にインストールしておいてください。
Python - ダウンロードしてインストールします。
Jupyter - pipを使ってインストールします。

手順

1. Python のインストール

Python がインストールされていない場合は、以下の手順でインストールしてください。

インストール

Python 公式サイトからインストールする場合(Windows, macOS)

Python の公式サイトからインストールパッケージをダウンロードし、インストールします。Python のバージョンは 3.6 以降が推奨されます。
ダウンロードしたインストーラーを実行し、インストールします。
インストール中に「Add Python to PATH」のチェックボックスを忘れずに選択してください。

Homebrew を使用して Python をインストールする場合 (macOS)

Homebrew がインストールされていることを確認する
ターミナルを開き、以下のコマンドを実行して Python をインストールします。
```
brew -v
```
インストールされている場合は、バージョンが表示されます。
```
Homebrew 4.2.15
```
Homebrew がインストールされていない場合は、以下のコマンドを実行してインストールする
```
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install.sh)"
```
Python をインストールする
```
brew install python
```

確認

Python が正常にインストールされたかどうかを確認する
```
python --version
```
または
```
python3 --version
```
正常にインストールされていれば、バージョンが表示されます。
```
Python 3.12.3
```
!

python --versionでバージョンが表示されない場合は、下記の記事を参考にしてください。

3. VSCode 拡張機能のインストール

VSCode を開き、左側の拡張機能アイコンをクリックします。
検索バーに「Python」と入力し、Microsoft が提供している Python 拡張機能をインストールします。

同様に「Jupyter」と入力し、Jupyter 拡張機能もインストールします。

4. 仮想環境の作成

仮想環境を作成することで、プロジェクトごとに異なる Python バージョンやパッケージを管理できます。

仮想環境を作成するためのディレクトリ(プロジェクトディレクトリ)を作成します。

作成済みの場合は、スキップしてください。
```
mkdir -p ~/dev/project
```
仮想環境を作成します。
```
python3 -m venv ~/dev/project/venv
```
仮想環境を有効化します。
```
source ~/dev/project/venv/bin/activate
```

5. Jupyter のインストール

仮想環境が有効化されていることを確認し、Jupyter をインストールします。

pip install jupyter

6. VSCode で Jupyter Notebook を開く

VSCode を開く
- プロジェクトディレクトリを VSCode で開きます。
```
code ~/dev/project
```
または、VSCode を開いてからプロジェクトディレクトリを開きます。
新しい Jupyter Notebook を作成する:
- コマンドパレットを開く（Ctrl+Shift+P または Cmd+Shift+P）。
- 「Jupyter: Create New Juptyer Notebook 」を選択します。
カーネルを選択する:
- 画面右上の「カーネルの選択」をクリックし、作成した仮想環境を選択します。
- 正しく仮想環境が認識されていれば、下記のように venv が表示されます。

7. 環境の確認

Notebook のセルに以下のコードを入力して、実行してみてください。
```
print("Hello, Jupyter!")
```
正常に出力されれば、環境構築は完了です。

まとめ

VSCode で Jupyter Notebook の開発環墧を構築する手順を紹介しました。
VSCode と Jupyter Notebook を組み合わせることで、より効率的に Python の開発を行うことができます。