Quick Start

クイックスタート

1. プロジェクトを作る

GitHub の Use this template から新しいリポジトリを作る方法を推奨します。作成後、ローカルへ clone します。

git clone <new-repository-url> my-research
cd my-research

公開／非公開は、データ利用条件、共同研究契約、倫理審査、投稿前ポリシーを確認して決めます。迷う場合は最初は private にします。

2. プロジェクト固有の名前を設定する

• pyproject.toml: name と description を変更
• docker-compose.yml: container_name と image を変更
• README.md: 研究タイトル、目的、利用方法を変更
• Compose のサービスキー research-template は、既存コマンドを保つため通常は変更しない

3. ローカル設定とコンテナを準備する

cp .env.example .env
id -u
id -g
docker compose up -d
docker compose exec research-template uv sync
docker compose exec research-template uv run pytest

.env は Git 管理外です。UID/GID、データのローカルパス、ポートなどだけを書き、秘密情報をコミットしないでください。

GPU を使う場合:

docker compose -f docker-compose.yml -f docker-compose.gpu.yml up -d

4. 研究固有の入口を整える

• README.md に研究目的、入力データ、主要コマンド、成果物を記載
• docs/ に最初の研究ログと重要な意思決定を作成
• config.py に共有パス、乱数シード、図の設定を集約
• 必要な依存はコンテナ内で uv add <package> し、pyproject.toml と uv.lock をコミット

5. GitHub の安全設定を確認する

新しく作ったリポジトリには、このテンプレート側の ruleset は自動コピーされない場合があります。既定ブランチに次を設定します。

• Pull Request 必須
• 必要な承認数を設定
• force push とブランチ削除を禁止
• Secret scanning と push protection を有効化
• Dependabot alerts と security updates を有効化
• 書き込み権限を必要な共同研究者だけに付与

詳しくは GitHubでの共同作業と安全運用 を参照してください。

6. 最初の解析へ進む

研究の仮説と評価指標を記録してから、exp/_template/ を次の番号へコピーします。以降は 研究ワークフロー と 実験の進め方 に沿って進めます。