計算物理におけるGitの使い方 / 01-c-compphys

Transcript

1. 1 17 計算物理におけるGitの使い方 慶應義塾大学理工学部物理情報工学科 渡辺 2026年3月9日 計算物理春の学校2026「計算物理屋のためのGit/GitHub入門」 の例
2. 2 17 計算物理におけるGitの使い道(例) コード開発 開発するコードをGitで管理 ローカルでのデバッグ クラスタやスパコンでコード共有 論文執筆 論文をGitで管理、GitHubに保存 バックアップ 共著者と共有しやすい ※ Overleaf派も多い ※
3. 3 17 計算物理におけるGitの使い道(例) データ共有 論文執筆に使ったデータを公開 ex) 物性研究所データリポジトリ 講義ノート公開 GitHubで講義ノートを公開 スマホで閲覧可能 退職後も消えない可能性が高い https://datarepo.mdcl.issp.u-tokyo.ac.jp/
4. 4 17 コード開発 ローカルで開発、リモートに保存 バックアップ コミット プッシュ コミットの頻度：デバッグの単位 プッシュの頻度：データが失われた時の手戻りの時間
5. 5 17 コード開発 ブランチによる作業分離 main feature コードに新しい機能を追加中にバグが見つかった 新しい機能追加とバグ修正を同時にやりたくない → ブランチによる作業分離 1. 機能追加開始 2. バグ修正 3. 機能マージ 1. 機能追加時に新しいブランチで作業 2. バグ発見時、mainに戻って修正 3. バグ修正後にブランチに戻り、機能をマージ 自分がいまどの作業をしているかが明確に
6. 6 17 コード開発 歴史を使ったデバッグ バグ発見時、古いバージョンへの切り替えが非常に簡単 二分探索によりバグの挿入箇所を特定 バグってるバージョン 正常なバージョン バグの範囲 容疑者の範囲は「コミットの頻度」により決まる
7. 7 17 コード開発 ローカル クラスタ スパコン 原則として、コードはローカルで開発、GitHubを経由してクラスタやスパコンへ ローカルとクラスタやスパコンで異なるバージョンの共存を防ぐ 実行サイトに依存するコード(SIMDとか)の差異は、Makefileなど のビルドシステムなどで吸収する
8. 8 17 ストレージサービスとの違い GoogleドライブやBoxなど、オンラインのファイル保存サービスの利用 • バージョン管理や履歴からの復元機能 • バックアップとしての機能は充実 • 管理対象ファイルの除外ができない or 面倒であることが多い • バックアップのタイミングの指定ができない or 面倒 • (個人的な意見だが)操作ミスがわりと起きる ローカル スパコン コード コード データ Gitでは原則として「コードから生成できるファイル」は管理しない Gitの 管理対象外
9. 9 17 論文執筆 ローカルで執筆、リモートに保存 バックアップ コミット プッシュ 投稿論文もそうだが、特に卒論、修論、博論のリモートバックアップは必須 ※ Overleafでも可。とにかくリモートに。 ※
10. 10 17 論文執筆 共著者との共有 「常に最新版がリモートにある」状態をキープ 必要に応じてリモートを通じて共著者と共有 USB受け渡しやメール添付は混乱の元 筆頭著者 共著者
11. 11 17 論文執筆 TeXファイル bibファイル 図のファイル 図を作るためのデータ 図を作るスクリプト等 論文執筆用リポジトリ プログラム開発用リポジトリ プログラムソース インプットファイル ジョブスクリプト等 • 論文執筆用とプログラム開発のリポジトリを分ける • 出力データはプログラム開発リポジトリにいれない • 図を作るためのデータは論文執筆用リポジトリに入れる • 大きなデータ(ダンプなど)はリポジトリに入れない リポジトリにより管理すべきファイル、除外すべきファイルが異なる 図を作るためのデータ
12. 12 17 論文執筆 計算と図の作成を一度にやらない インプット 全部やる プログラム 図 インプット 計算 プログラム 結果 dat 図の作成 プログラム 図 • 線の太さや軸のフォントなど、図はなんども作り直すから • 結果ファイルと図の作成プログラムを論文リポジトリに入れたい
13. 13 17 論文執筆 図とスクリプトのファイル名は揃える 0.000000 0.041263 0.100000 0.143985 0.200000 0.188462 0.300000 0.241296 0.400000 0.264365 0.500000 0.309186 0.600000 0.444013 .... pressure.dat set term pdf set out "pressure.pdf" set xlabel "t" set ylabel "P" p "pressure.dat" pt 6 t "Data" pressure.plt $ gnuplot pressure.plt pressure.pdf hoge.pdfを作りたければhoge.pltや hoge.pyを探せばよい
14. 14 17 論文執筆 コマンド一発で図が全てできるのが望ましい all: pressure.pdf temperature.pdf %.pdf: %.plt %.dat gnuplot $< Makefile pressure.datとtemperature.datから pressure.pltとtemperature.pltを使って pressure.pdfとtemperature.pdfを作る 「そのディレクトリに入ってmakeしたら必要なものが揃う」 という状況を作る ※ Pythonやシェルスクリプト等でも良い。とにかくコマンド一発で。
15. 15 17 データ共有 近年、論文執筆に使ったデータを公開する動きが活発に The data supporting the findings of this study are available upon reasonable request. こんなこと言ってたらもう引用されない？ https://datarepo.mdcl.issp.u-tokyo.ac.jp/ 物性研究所データリポジトリ https://isspns-gitlab.issp.u-tokyo.ac.jp/kaityo256/aging_network_data データ公開例
16. 16 17 講義ノート公開 大学のサーバに置くと、退職後に消える PDFで置くとスマホでは見づらい GitHubへの講義ノート公開 https://kaityo256.github.io/python_zero/ レスポンシブ • 退職後も(多分)消えないし、消える前にフォーク可能。 • レスポンシブにすればスマホでも見やすい
17. 17 17 まとめ • 計算物理におけるGit/GitHubの用途は主にコード開 発と論文執筆 • リモートリポジトリを使うことで自動的にバック アップ • GitHubをコードや論文の「ハブ」として使う • GitHub経由でコードをクラスタやスパコンへ • GitHub経由で論文を共著者へ共有 • 公開手段としてのGitHub • データを公開 (物性研データリポジトリの利用) • 講義ノートの公開