POSIM v1.0.1Platform for Ocean Simulation · ドキュメント
ドキュメントメニュー
POSIM / 参考情報と開発

開発への参加

コードとドキュメントの改善を歓迎します。再現できる小さな変更から始め、モデル、コントローラー設定、ガイドの内容をそろえてください。

ブランチで作業する

git clone https://github.com/IOES-Lab/POSIM.git
cd POSIM
git switch -c my-change

シミュレーションの変更には、適切なインストール環境を使います。生成されたビルド・インストールディレクトリや、ローカルの認証情報をコミットしないでください。

変更した動作を確認する

関連する最小の例を選びます。リソースの解決、モデルの配置、時刻の進行、データ受信、必要に応じた制御動作、正常終了を確認してください。リビジョン、レンダラー、アーキテクチャ、コマンドを記録します。

センサーや動力学の変更には、適切な数値比較が必要です。スクリーンショットは見た目を示しますが、物理モデルの精度を証明するものではありません。継承したコードを修正する際は、元の著者・出典表示を保持してください。

8言語の文書を更新する

サイトは英語、韓国語、スペイン語、フランス語、ドイツ語、イタリア語、日本語、中国語に対応します。英語は/、他の言語は/ko/、/es/、/fr/、/de/、/it/、/ja/、/zh/を使います。

website/content/<言語コード>の対応するファイルを更新してください。コマンド、単位、前提条件、制約は一致させ、文章は自然な表現と一般的なロボティクス用語で書きます。共通のCODEとMEDIAプレースホルダーで実行例や図を再利用できます。すべての言語に全ページが必要で、欠けた本文を英語で代用しません。

公開機能を変更する場合:

ページ順は共通で、ワールドと物体の一覧はソースから生成します。現在の製品の使い方を記載してください。内部メモ、計画、検証報告はリポジトリに含めず、変更の議論や検証結果はIssueとPull Requestに残します。

サイトを確認する

Node.js 24とpnpm 10.11.0を用意し、websiteで実行します。

pnpm install --frozen-lockfile
pnpm build
pnpm check
pnpm preview

http://127.0.0.1:4174を開き、リンク、コマンドのコピー、検索、言語切り替え、モバイルメニューを確認します。公開と保守の説明はwebsite/README.mdを参照してください。

Pull Requestを作成する

問題、変更後の動作、実施した検証を説明します。シミュレーション変更には関連するコマンドとログ、レイアウト変更にはデスクトップ・モバイルの表示を添えます。確認済みと未確認の項目を区別してください。

再現できる不具合はGitHub Issues、変更のレビューはPull Requestsを使います。プロジェクトはKorea Maritime & Ocean UniversityのIOES-Labが保守しています。