Dev Container を使った
開発環境構築ガイド

pyMEA の開発環境を誰でも同じようにセットアップできます

このガイドについて

対象者

  • プログラミングを始めたばかりの方
  • Python の環境構築でつまずいた方
  • 「自分のパソコンでは動かない」経験がある方

ゴール

このガイドを終えると...

  • Dev Container が起動している
  • python --version で Python 3.12 が表示される
  • pyMEA がすぐに使える状態になっている

Dev Container(開発コンテナ)とは?

プログラムを動かすための「専用の箱」 をパソコンの中に作る仕組みです。

diagram

この「箱」の中に pyMEA を動かすために必要なものがすべて入っています。

なぜ Dev Container を使うの?

1. 「動かない」が起きない

バージョン違いによるトラブルがなくなります。
Dev Container なら 全員が全く同じ環境 で作業できます。

2. パソコンを汚さない

ライブラリは「箱」の中にインストール。
不要になったら 箱ごと削除 するだけ。

3. セットアップが一瞬

「何をインストールするか」の設定がすでに用意されています。
コマンド1つで環境が整います。

4. 全員が同じ環境を使える

設定ファイルがリポジトリに含まれているため、
チームで環境を共有できます。

事前準備

4つのソフトウェアをインストールする(すべて無料)

事前準備:必要なソフトウェア 4つ

# ソフトウェア 役割
1 Git リポジトリのダウンロード・変更履歴管理
2 Docker Desktop 「専用の箱」を作るためのソフト
3 Visual Studio Code コードを書くためのエディタ
4 Dev Containers 拡張機能 VS Code と Docker を連携させる

ステップ 1:Git をインストールする

Git とは? ファイルの変更履歴を管理するツールです。プロジェクトのダウンロードにも使います。

Windows: https://gitforwindows.org/ からダウンロード
→ インストーラーを起動して「Next」を押し続けるだけで OK

Mac: ターミナルで git --version を実行
→ インストールを促すダイアログが表示されたら指示に従う

git --version
# git version 2.x.x と表示されれば OK

ステップ 2:Docker Desktop をインストールする

Docker とは? 「専用の箱(コンテナ)」を作るためのソフトウェアです。

  1. https://www.docker.com/products/docker-desktop/ にアクセス
  2. OS(Windows / Mac)向けのインストーラーをダウンロード
  3. インストーラーを起動してインストール
  4. Docker Desktop を起動(タスクバーにクジラのアイコンが表示されれば起動中)

Windows の注意: WSL 2 のインストールを求められたら画面の指示に従ってください。

docker --version
# Docker version 2x.x.x と表示されれば OK

ステップ 3 & 4:VS Code と拡張機能をインストールする

VS Code のインストール

  1. https://code.visualstudio.com/ からダウンロード
  2. インストーラーを起動してインストール

Dev Containers 拡張機能

  1. VS Code を起動
  2. 左の 拡張機能アイコン をクリック
  3. 検索ボックスに Dev Containers と入力
  4. Dev Containers(Microsoft 製)をインストール

事前準備はこれで完了です!

セットアップ

リポジトリのクローンから Dev Container 起動まで

セットアップの全体の流れ

diagram

Step 1:リポジトリをクローンする

クローンとは? GitHub 上のプロジェクトを自分のパソコンにコピーすることです。

Mac はターミナル、Windows は Git Bash を開いて実行します。

Windows の注意: コマンドプロンプトや PowerShell ではなく Git Bash を使ってください。
スタートメニューで「Git Bash」と検索して起動してください。

mkdir -p ~/Workspace          # Workspace フォルダを作成
cd ~/Workspace                # 移動
git clone https://github.com/kkito0726/MEA_modules.git

実行後、~/Workspace/MEA_modules フォルダが作成されます。

Step 2:計測データの場所を登録する(Windows)

重要: Dev Container を開く 前 に必ず完了してください。

リポジトリフォルダ内の setup.bat をダブルクリックして実行します。

MEA_modules/
├── setup.bat   ← これをダブルクリック
├── pyMEA/
└── ...
データフォルダのパス: E:\MEA_data  ← 入力して Enter

設定完了!コンテナ内からは /data でアクセスできます。

「設定完了!」と表示されたら VS Code を再起動 してください。

Step 2:計測データの場所を登録する(Mac)

ターミナルを開いて以下のコマンドを実行します。

# パスを ~/.zshrc に追記
echo 'export MEA_DATA_PATH="/Volumes/MyHDD/MEA_data"' >> ~/.zshrc

# 設定を反映
source ~/.zshrc

/Volumes/MyHDD/MEA_data の部分はご自身のパスに変更してください。
Finder でフォルダを開いてアドレスバーからコピーできます。

設定後は VS Code を再起動 してください。

コンテナ起動後は外付けHDDのデータを /data からアクセスできます:

mea = read_MEA("/data/sample.hed", start=0, end=5, electrode_distance=450)

Step 3 & 4:VS Code でフォルダを開く

code ~/Workspace/MEA_modules

または VS Code のメニューから「ファイル」→「フォルダーを開く」で MEA_modules を選択。

フォルダを開くと 右下に通知 が表示されます:

┌──────────────────────────────────────────────────────┐
│  フォルダーにデブコンテナー構成ファイルが含まれています。  │
│                                                        │
│     [コンテナーで再度開く]             [後で]           │
└──────────────────────────────────────────────────────┘

「コンテナーで再度開く」 をクリックしてください。

通知が表示されない場合:VS Code 左下の 緑色の >< アイコン をクリック

Step 5:環境の自動セットアップを待つ

初回はライブラリのダウンロード・インストールが 自動で 行われます。

diagram

VS Code の左下が以下のように変われば成功です:

Dev Container: Python 3

動作確認

Dev Container が起動したら、VS Code の ターミナル を開きます。
(メニュー:「ターミナル」→「新しいターミナル」)

python --version
# Python 3.12.x と表示されれば OK
python -c "import pyMEA; print('pyMEA が使えます!')"
# pyMEA が使えます! と表示されれば OK

トラブルシューティング

よくある質問と解決方法

よくあるトラブル(1 / 4)

Q1. 「コンテナーで再度開く」の通知が表示されない

VS Code 左下の緑色の >< アイコンをクリックして「コンテナーで再度開く」を選択してください。

Q2. Docker Desktop が起動していないと言われる

Docker Desktop を起動して、クジラのアイコンが表示されるまで待ってから再度試してください。

Q3. 「WSL 2 インストールが必要」と表示される(Windows)

表示されたリンクから WSL 2 をインストールしてください。インストール後にパソコンの再起動が必要な場合があります。

よくあるトラブル(2 / 4)

Q4. コンテナのビルドが途中で止まる

インターネット接続を確認してください。ライブラリのダウンロード中はネット接続が必要です。

Q5. コンテナ起動時にエラーが出てデータが見つからない(Windows)

setup.bat を実行する前に Dev Container を開こうとした可能性があります。一度 Dev Container を閉じ、setup.bat を実行し、VS Code を再起動してから再度開いてください。

Q6. /data の中身が空に見える

外付けHDDがパソコンに接続されているか確認してください。接続されている場合は setup.bat(Windows)または ~/.zshrc(Mac)に設定したパスが正しいか確認してください。

よくあるトラブル(3 / 4):クラウドストレージ

Q. OneDrive や Google Drive に計測データを保存している場合は?

ストレージ 動作 対処
OneDrive / Dropbox(同期済み) OK 「常にこのデバイスに保存する」に設定
Google Drive(ミラーモード) 不安定 動く場合もあるが不安定
Google Drive(ストリームモード) 不可 Docker からアクセス不可

推奨: MEA 計測データは1ファイルで数百MB〜数GBになることがあります。
外付けHDDへの保存を推奨します。 クラウドストレージはバックアップ用途にとどめてください。

よくあるトラブル(4 / 4):ディスク容量・定期メンテナンス

Q7. No space left on device が出る / install・ビルドが失敗する

Docker のビルドキャッシュが溜まって空きがなくなっている可能性があります。コンテナの外(Mac / Windows のターミナル)で次を実行してください。

docker builder prune -f

実行後、コンテナのリビルドや pip install を再度試してください。

定期メンテナンス推奨: リビルドを繰り返すとキャッシュが溜まります。「重くなった」「ビルドや install が失敗するようになった」と感じたら、まず docker builder prune -f。月1回程度の定期実行もおすすめです。キャッシュを消すだけで イメージや /data のデータには影響しません。足りなければ docker system prune -f も使えます。

アップデート方法

開発者から「アップデートしてください」と連絡が来たとき:

Step 1:最新コードを取得する

VS Code のターミナルを開いて実行:

git pull
# Updating abc1234..def5678

Step 2:コンテナを再ビルドする

VS Code 左下の Dev Container: Python 3 をクリック
→ 「コンテナーのリビルド」 を選択

または F1 → rebuild と検索して選択

環境構築が完了しました!

次のステップ:README_ja.md を参照して pyMEA の使い方を確認してください。

Jupyter Notebook でのデータ解析も、同じ Dev Container 環境でそのまま使えます。
.ipynb ファイルを開くだけで使えます。