Development environment

Quick Start Guide

開発環境の用意

  1. Docker Desktopをインストールする.
  2. VS Codeをインストールする.
  3. VS Codeに拡張機能 Remote Containers をインストールする.

開発リポジトリの用意

  1. オリジナルのリポジトリをフォークする.
  2. ローカルにフォークしたリポジトリをクローンする.
  3. VS Codeでローカルのリポジトリを開く.
  4. コマンドパレットから Remote-Containers: Open Folder in Container... を実行
  5. プロジェクトのフォルダがコンテナ内で開かれる. 初回ビルドの時は時間がかかる可能性がある.
  6. main.jlを開く.
  7. コマンドパレットから Julia: Execute File in REPL を実行する.
  8. プログラムが動けば成功!

Remote -Containersのインストール

Remote-Containersは,Dockerコンテナ内でVS Codeを開いて開発を行うことが出来るようにするVS Codeの拡張機能です.インストールは簡単です.

  1. VS CodeのEXTENSIONS: MARKETPLACEでremote-containersを検索する.
  2. Remote-Containersをインストールする

開発環境の設定ファイル

FlexibleSpacecraft.jlのリポジトリをクローンしてください.ソースコード・ドキュメンテーションおよび開発環境の構築に必要なファイルがすべてダウンロードされます.

開発環境はDockerコンテナの中に用意しています..devcontainer/DockerfileにDocker Imageを作るためのDockerfileが用意されています.

  • Dockerfileは,必要なアプリやパッケージと環境設定を記述したファイルです.このファイルを基にしてコンテナが作られます.
  • devcontainer.jsonは,VS codeの拡張機能Remote-Containersを使ってコンテナを立ち上げてVS codeで開発する際の設定などを書いておくファイルです.extensionsの部分に,リモート環境で使いたいVS Codeの拡張機能を書いておくと,VS Codeでコンテナを開くときにインストールされます.今回はJuliaの拡張機能を追加します.ほかにリモート環境で使いたい拡張機能を書いておけば,インストールされます.このファイルに書く内容は,VS Codeで拡張機能のページを開いたとき,下の図の赤枠の部分に表示されます.

Package FlexibleSpacecraft のアップデート

開発環境を用意出来たら,まずパッケージのアップデートをする必要がある.

  1. julia> ]: パッケージモードに入る
  2. (FlexibleSpacecraft) pkg> update: パッケージをすべてアップデート
  3. 依存パッケージがアップデートされる.

Reference