diff --git a/README.md b/README.md index 48a52a5..bb7046b 100644 --- a/README.md +++ b/README.md @@ -51,6 +51,42 @@ ## インストール +### 0. Pythonのインストール確認 + +このツールを使用する前に、**Python 3.10以上**がインストールされていることを確認してください。 + +**バージョン確認:** +```bash +python3 --version +``` + +または + +```bash +python --version +``` + +Python 3.10以上が表示されればOKです。インストールされていない場合は、以下の方法でインストールしてください。 + +#### Pythonのインストール方法 + +- **Windows**: + - [Python公式サイト](https://www.python.org/downloads/)から「Windows installer (64-bit)」をダウンロード + - インストーラー実行時に **「Add Python to PATH」に必ずチェック**を入れてください + +- **macOS**: + - Homebrewを使用(推奨): + ```bash + brew install python@3.10 + ``` + - または[Python公式サイト](https://www.python.org/downloads/)からmacOS installerをダウンロード + +- **Linux (Ubuntu/Debian)**: + ```bash + sudo apt update + sudo apt install python3.10 python3.10-venv python3-pip + ``` + ### 1. リポジトリのクローン ```bash @@ -58,7 +94,30 @@ cd ivus-complication-annotation-tool ``` -### 2. 依存パッケージのインストール +### 2. 仮想環境の作成と有効化 + +**仮想環境を作成:** +```bash +python3 -m venv venv +``` + +**仮想環境を有効化:** + +- **Linux/macOS:** + ```bash + source ./venv/bin/activate + ``` + +- **Windows:** + ```bash + venv\Scripts\activate + ``` + +仮想環境が有効化されると、プロンプトの先頭に `(venv)` が表示されます。 + +### 3. 依存パッケージのインストール + +仮想環境を有効化した状態で、以下のコマンドを実行します: ```bash pip install -r requirements.txt @@ -93,11 +152,13 @@ #### 2. データディレクトリパス(必須) - 症例フォルダ(CHIBAMI_xxx_pre)が含まれるディレクトリを選択 -- 📁 参照 ボタンでWindows標準のフォルダ選択ダイアログで選択してください +- **Windowsの場合**: 📁 参照 ボタンでWindows標準のフォルダ選択ダイアログで選択してください +- **macOSの場合**: Finderでフォルダを選択し、`Command + Option + C` でパスをコピーして貼り付けてください #### 3. Excelラベルファイルパス(必須) - 正解ラベルが記載されたExcelファイル(CHIBAMI_case_list_xxx.xlsx)を選択 -- 📁 参照 ボタンでWindows標準のファイル選択ダイアログで選択してください +- **Windowsの場合**: 📁 参照 ボタンでWindows標準のファイル選択ダイアログで選択してください +- **macOSの場合**: Finderでファイルを選択し、`Command + Option + C` でパスをコピーして貼り付けてください **注意**: 全ての項目を正しく入力しないと、アノテーション開始ボタンが有効になりません。 @@ -159,11 +220,6 @@ └── ... ``` -**重要**: -- フォルダ名: CHIBAMI_{症例番号}_pre -- 画像形式: PNG -- 画像ファイル名: frame_{症例番号}_{フレーム番号}.png - ### 出力CSV形式 保存されるCSVファイル名: annotations_{アノテーター名}.csv @@ -204,36 +260,57 @@ ### Q2: 📁 参照 ボタンを押してもダイアログが開かない -**A2**: WSL(Linux環境)で実行している可能性があります。このツールはWindows環境での使用を前提としています。 +**A2**: WSL(Linux環境)またはmacOSで実行している可能性があります。 -- **対処法**: Windows上で直接Pythonを実行してください。 -- WSL環境では、パスを手入力(コピー&ペースト)してください。 +- **Windowsの場合**: Windows上で直接Pythonを実行してください。WSL環境では、パスを手入力(コピー&ペースト)してください。 +- **macOSの場合**: Finderでフォルダ/ファイルを選択し、`Command + Option + C` でパスをコピーして貼り付けてください。 -### Q3: フォルダ/ファイルが見つからないとエラーが出る +### Q3: Pythonがインストールされていない、またはバージョンが古い -**A3**: パスが正しいか確認してください。 +**A3**: Python 3.10以上が必要です。以下のコマンドでバージョンを確認してください。 + +```bash +python3 --version +``` + +または + +```bash +python --version +``` + +インストールされていない、またはバージョンが3.10未満の場合は、[インストールセクション](#0-pythonのインストール確認)を参照してインストールしてください。 + +- **Windows**: [Python公式サイト](https://www.python.org/downloads/)からダウンロード(「Add Python to PATH」に必ずチェック) +- **macOS**: `brew install python@3.10` (Homebrew推奨) +- **Linux (Ubuntu/Debian)**: `sudo apt install python3.10 python3.10-venv python3-pip` + +### Q4: フォルダ/ファイルが見つからないとエラーが出る + +**A4**: パスが正しいか確認してください。 - **Windowsパスの例**: C:\Users\YourName\Documents\data +- **macOS/Linuxパスの例**: /Users/YourName/Documents/data または /home/YourName/Documents/data - **WSLパスの例**: /mnt/d/Research/data/...(Windows環境では使えません) -### Q4: CSVをExcelで開くと文字化けする +### Q5: CSVをExcelで開くと文字化けする -**A4**: 通常は発生しませんが、もし発生した場合: +**A5**: 通常は発生しませんが、もし発生した場合: 1. Excelでデータ→テキストファイルから を選択 2. エンコーディングをUTF-8に指定して開く -### Q5: 画像が表示されない +### Q6: 画像が表示されない -**A5**: 以下を確認してください: +**A6**: 以下を確認してください: 1. データディレクトリ内に CHIBAMI_{番号}_pre/images/ フォルダが存在するか 2. images/ フォルダ内に frame_*.png ファイルが存在するか 3. PNGファイルが破損していないか -### Q6: 進捗が保存されない +### Q7: 進捗が保存されない -**A6**: CSVファイルの保存先を確認してください。 +**A7**: CSVファイルの保存先を確認してください。 - 保存先: {データディレクトリ}/annotations_{アノテーター名}.csv - 例: C:\Users\YourName\Documents\data\annotations_tanaka.csv @@ -259,27 +336,6 @@ --- -## 開発者向け情報 - -### コーディング規約 - -- **変数名・関数名**: 英語(スネークケース) -- **UIラベル**: 日本語 -- **型ヒント**: 可能な限り使用 -- 詳細は CLAUDE.md を参照 - -### 起動コマンド(開発用) - -```bash -# 自動リロード有効 -python -m streamlit run app.py - -# ポート指定 -streamlit run app.py --server.port 8501 - -# ブラウザを自動で開かない -streamlit run app.py --server.headless true -``` --- diff --git a/app.py b/app.py index b6b0852..f4f66ea 100644 --- a/app.py +++ b/app.py @@ -213,7 +213,7 @@ st.session_state.temp_data_root = data_root with col2: - if st.button("📁 参照", key="btn_browse_data", use_container_width=True): + if st.button("📁 参照 (Windowsでのみ利用可能 MacOS, Linuxの場合はパスを入力)", key="btn_browse_data", use_container_width=True): if TKINTER_AVAILABLE: # Use current path as initial dir if exists, otherwise use home directory initial = st.session_state.temp_data_root if st.session_state.temp_data_root else os.path.expanduser("~") @@ -250,7 +250,7 @@ st.session_state.temp_excel_path = excel_path with col2: - if st.button("📄 参照", key="btn_browse_excel", use_container_width=True): + if st.button("📄 参照 (Windowsでのみ利用可能 MacOS, Linuxの場合はパスを入力)", key="btn_browse_excel", use_container_width=True): if TKINTER_AVAILABLE: # Use directory of current path as initial dir if exists initial = os.path.dirname(st.session_state.temp_excel_path) if st.session_state.temp_excel_path else os.path.expanduser("~")