MDS Devcontainer Template

数値計算に必要な環境を迅速に構築できるDevcontainerテンプレート

概要

このリポジトリを元にしたリポジトリをクローンし，VSCodeで開くと，数値計算に必要な環境が一発で構築されます． また，LinterやFormatterも設定済みで，品質の高いコードを書くための環境が整っています．

• Python 3.12 + Numpy + JupyterNotebook
• Julia
• gcc/gFortran + MPI

使用方法

1. 必要なツール類をインストールします．

   • Git
   • Docker
   • VSCode
   • VSCode Devcontainer Extension

2. GitHubアカウントを作成します.

   • こちらの記事を参考にしてください: Githubアカウント作成方法

3. Gitを設定します． ターミナルを開き，以下のコマンドを実行して，ユーザー名とメールアドレスを設定します．

   git config --global user.name "GitHubアカウントのユーザー名"
   git config --global user.email "GitHubに登録したメールアドレス"

4. このリポジトリを元に新しいリポジトリを作成します．

   • GitHubのUse this templateボタンをクリックして，新しいリポジトリを作成します．
   • リポジトリ名は任意ですが，例えば<苗字>-mds-workspaceのようにするのが良いでしょう．

5. VSCodeで新しいリポジトリをクローンして開きます．

   • ターミナル上で以下のコマンドを実行します． 初めての場合は認証が必要になることがあります．

   git clone <作成したリポジトリのURL>

6. VSCode上でDevcontainerを開きます．

   • Ctrl+Shift+P(Windows), Cmd+Shift+P(Mac)を押してコマンドパレットを開き，Dev Containers: Rebuild and Reopen in Containerを選択します．
   • しばらく待ちます(15分程度かかる場合があります)．

7. srcディレクトリ以下にディレクトリを作成し，数値計算のコードを書き始めます．

   • 必要に応じてサンプルコードを参考にしてください．

8. 実行やGit操作はVSCode上で行うことができます．

   • 左のサイドバーの実行アイコンをクリックしてコードを実行したり，ソース管理アイコンをクリックしてGit操作を行ったりできます．使い方についてはCopilotなどに聞くと良いでしょう．

注意

• 全ての開発作業はDevcontainer内で行ってください．Devcontainer外でコードを実行すると，必要なライブラリがインストールされていないため，エラーになります．

  • Devcontainer内にいるかどうかは，VSCodeの左下にDev Container:と表示されているかで確認できます．
  • Devcontainerを開くには，Ctrl+Shift+P(Windows), Cmd+Shift+P(Mac)を押してコマンドパレットを開き，Dev Containers: Reopen in Containerを選択します．
  • Devcontainer内のターミナルを開くには，VSCodeのメニューからTerminal -> New Terminalを選択します．

• Pythonのバージョンを変更したい場合は，Devcontainer内のターミナルで以下のコマンドを実行してください．

  uv python pin <バージョン名>
  uv sync

• Pythonのパッケージを追加したい場合は，Devcontainer内のターミナルで以下のコマンドを実行してください．pipやcondaは使用できません．

  uv add <パッケージ名>

• Fortranのライブラリを追加したい場合は，libディレクトリに配置し，Makefileで-Iオプションを指定してください．