Newer
Older
SmTIAS-Evaluation / docs / 02_ENV / ENV_02_環境構築手順.md

環境構築手順 (Environment Setup)

前提条件 (Prerequisites)

  • uv がインストール済みであること(Windows: winget install --id=astral-sh.uv -e.Python 本体は uv が .python-version(3.12)に従って用意するため,別途のインストールは必須ではない)
  • Git がインストール済みであること
  • GitHub CLI (gh) がインストール済みであること
  • bash が使えること(Windows では Git for Windows 付属の Git Bash).Claude Code のフック(.claude/settings.json)は bash .claude/hooks/run_python.sh 経由で Python を起動するため,Python と bash のどちらかが欠けるとリポジトリ外アクセス制限フックがファイル操作をすべてブロックする

日常の開発コマンド(テスト・lint・解析スクリプト)は ENV_04 を参照.

手順 (Steps)

リポジトリのクローン (Clone Repository)

git clone <repository-url>
cd SmTIAS-Evaluation

仮想環境の作成と依存パッケージのインストール (Create Environment & Install Dependencies)

uv sync

uv.lock に固定されたバージョンで .venv が作成される(開発用の dev グループ(ruff・pytest)も既定で入る).以降のコマンドは uv run <コマンド> で実行すれば,仮想環境を有効化する必要はない.

動作確認 (Verify Installation)

uv run python -c "import cv2, numpy, scipy, pandas, matplotlib, streamlit, skimage, PIL, rawpy; print('OK')"

OK と表示されれば成功.

データディレクトリ (Data Directory)

画像データは data/ ディレクトリに配置する.このディレクトリは .gitignore で管理対象外としている.

data/
├── smtias/          # SmTIAS で撮影した画像
│   └── whiteboard/    # 白板画像
└── tias/              # TIAS で撮影した画像
    └── whiteboard/    # 白板画像

※ ディレクトリ構成は解析の進行に応じて拡張する.

出力ディレクトリ (Output Directory)

解析結果は output/ ディレクトリに出力される.このディレクトリも .gitignore で管理対象外としている.