神戸大学大学院経済学研究科講師　山﨑潤一

目次

話の前提

• なるべく簡単に、異なるマシン間で同じ結果や作業環境を担保するためのセットアップガイドです。これさえあれば、

  • 共著者やRAとコードを共有したのに計算結果が違う！
  • あの人の手元ではコンパイルできたファイルがこっちではコンパイルできない！スライドを修正したいのに手元で回らない！やばい！
  • あの日サブミットしたバージョンと何が違うかわからないけどうまく回らなくなった！あの日のやつに戻したいけど、Dropboxだとどのファイルをどこまで戻せばいいのかわからないし、そもそもいつの日付のファイルに戻せばいいのかもわからない。。。

  などの研究者にとっては厄介なトラブルからオサラバできるはずです。ついでにGitというバージョン管理ソフト/GitHubというWebサービスを使うので、draft_final.tex, draft_final2.tex, draft_final_final.tex …などの後から見返したら完全に謎なファイルたちの出現を抑えたり、協業をスムーズにすることができます。

• 基本的に全て無料です。強いていえば、rawデータを保存しておくストレージは有料な可能性がありますが、大学で利用可能なストレージ等を使えば良いでしょう。

• セットアップにはDockerとGitを使います。

  • Dockerとはざっくりいうとあなたのpcの中に別個の仮想マシンをセットアップするソフトです。この仮想マシンの設定をプロジェクト内で共有すれば、全員が必ず同じ環境で研究をすることになります。
    • Dockerを使うのにそれなりにリソースを使うので、ドライブやメモリに余裕があった方が良いです。
  • Gitはバージョン管理をするソフトです。またそのバージョン管理の情報をwebに送って、他の人と共有したり、互いのコードを確認するプラットフォームとしてGItHubというwebサービスを使います。

• Rを使って分析するDockerのコンテナと、Latexをコンパイルするためのコンテナの二つを使い分けます。二つをまとめた自作のものを用意した方がスッキリするのですが、維持管理するコストが高いので、やめました。自前でdockerのイメージ作成をする必要がなく、必要に応じてR→Pythonなどとコンテナを入れ替え可能なので、応用しやすいと思います。

  • 常に両方のコンテナを使わなくても良いので、Latexだけ使いたいといった用途でもこのガイドは有用です。

• 説明の便宜上、この研究プロジェクトには管理者と作業者の役割を担う人たちがそれぞれいるとします。単独で行うプロジェクトの際は、管理者の役割も行うことになります。特定の役割の人のみ必要な作業等は、適宜（管理者向け）などと記載します。

• 山﨑がmacを使っているのでmac的な言葉遣いになっていますが、ターミナル→コマンドプロンプト、cmd → ctrlと読み替えればwindowsでもほぼ同じはずです。

最初のセットアップ（1-2時間程度かかるかも）

1. Docker Desktopをマシンにインストールする

   1. windowsの場合はwsl2をインストールしないといけないらしい。ただwindows 11では便利にインストールできるらしい。この辺りの記事を参照。

2. VSCodeをマシンにインストールし、Remote Developmentのextensionをインストールする

   1. ついでにVScodeのdockerのextensionも入れておくといい

3. Gitをマシンにインストールし、GitHubのアカウントを取得する

4. GitHubの画面右上からsettings→Developers Settings→Personal Access TokensからTokens (classic)を選択し、適当な名前をnoteに書き（access_githubなど）expirationをno expirationに設定、repoだけにチェックを入れ、Generate Tokenする。これでGitHubとの接続時に使うパスワードが得られる。後で使うので手元のテキストファイルにメモしておく。これでrepositoryの内容を書き込むアクセス権のためのパスワードとして使える。複数台所持していても同じパスワードで大丈夫。一回しか表示されないので、忘れた場合は消して再度作成する。2台目に入力する際に忘れていても、追加で作成して違うパスワードを入れても良い。ただしパスワードの管理は厳重に（ネット上に上げないこと）！

   

5. （管理者向け）

   1. テンプレートとなるリポジトリyamasaki/r-latex-researchenvのページに行き、緑色のUse This Templateボタンをクリック、Create a new repositoryを選択。ここで自分の新しいプロジェクト名などを設定し新しくリポジトリを作成。リポジトリはprivateにしておく。include all branchesはチェックなしで基本的にok。

      

   2. aで作成したリポジトリから、code→HTTPS→アドレスの右側に出る二重四角のボタンを押してアドレスをコピー

      

   3. その後、ターミナル画面でGit関係のファイルをおきたい場所（適宜documents/gitなどとすると良いかも）まで移動してから、git clone さっきコピーしたアドレスとうつ。するとユーザー名とパスワードを求められるので、tokenでのログインを選択し、GitHubでのユーザー名と上で発行したpersonal tokenをパスワードに入力する。そうするとGitHubから手元にファイルがダウンロードされる。

   4. 最低限必要なコードなどを適宜追加して、ターミナルでdocument/git/デポジトリの名前にcdする。そこから以下のようにコミット（記録）、GitHubにプッシュ（GitHubサーバーにローカルの内容を同期）する。ただし、初めてgit pushする際には、ユーザー名とstep4で作ったトークンをパスワードとして入力する必要がある。

      git add . # 変更内容を全てコミット（記録）対象にする
      git commit -m "initial commit" # コミット
      git push # コミット内容をGitHub側に同期させる
      

      1. 必要であればgit add .する前にフォルダ構造や.gitignoreを調整する。.gitignoreはgitの管理から外すファイルを指定するファイル。texの不必要なファイルやmacが勝手に作成するフォルダなどのメタ情報が入った.DS_storeなどがあらかじめ管理外として指定されています。デフォルトではdataフォルダの内容は全て管理外（この記事を参考に設定されている）。
      2. containerの中でのターミナルからgit pushするためには、ここを参考にして設定を行う。macの場合、$HOME/.ssh/ファイル名で良いはず。

   5. 必要な生データをdropboxなどでチームメンバーに共有する。その入手方法（dropboxのリンクなど）をreadmeに記載するなどしてプロジェクトメンバーに知らせる。

6. 作業者はプロジェクトリポジトリを5-b,5-cと同じ手順で手元にcloneし、生データをdropboxなどから手元のリポジトリの適切な場所に追加する（通常data/rawdataのような場所に置くことが多い、適宜管理者の指示を仰いだりreadmeを確認する）。