docs(manual): update for eq + tot + MCP additions#97
Merged
Conversation
2026-04-19 改訂. tr/ti/wr/wrx/fp の 5 章はそのまま保持し, 新たに第 8 章 eq モジュール (6 関数 C ABI と PSIB 0-origin の 解説含む), 第 9 章 tot モジュール (名前空間プレフィックス設計) を追加. 完了モジュールを 5 → 7 に拡大. - 第 8 章 (eq): 概要, ビルド, hello-world, set_param_str (KNAMEQ), PSIB 0-origin / run() mode=1 デフォルトの FAQ, 約 60 件の パラメータ表, EqState フィールド, F90 modernization (F-1..F-5) への言及, 変更履歴 (PR #54/#65/#70/#78/#80/#86/#92/#89 と #71/#79/#81/#87/#93) - 第 9 章 (tot): 概要, ビルド, hello-world, namespace prefix ディスパッチ表, wr→wrx 別名, dict/set_param_str, 既知制約 (init/run/get_state/finalize は L-3/L-4/L-5 でスタブ), 変更履歴 (PR #43/#82/#85/#91/#94) - 状況章を更新: モジュール完了マトリクスを 7 行化, eq F90 modernization (F-1..F-5) 完了マトリクス追加, MCP サーバ群 (tr/ti/wr/wrx/fp + tot 進行中, 6 個) 追加 - 残作業: trlib のみ実装の plot/TOML runner 横展開 (deferred), チュートリアル Notebook 集 (deferred) - 付録 PR 一覧を 2026-04-19 (#96 まで) に最新化, eq/tot/MCP 追記 - 補足カタログに eq/tot の最短例 2 つを追加 - xelatex 2 回コンパイル成功, PDF 55 ページ (旧版から +拡張) Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Owner
Author
|
@cursor review |
There was a problem hiding this comment.
✅ Bugbot reviewed your changes and found no new issues!
Comment @cursor review or bugbot run to trigger another review on this PR
Reviewed by Cursor Bugbot for commit 0abc777. Configure here.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
2026-04-18 初版マニュアル (#73) の改訂. 完了モジュールが 5 個 (tr/ti/wr/wrx/fp) から 7 個 (+eq/tot) に拡大したのに合わせ, 新章 2 つを追加し既存章を最新化しました.
New chapters
Updated existing sections
Page count delta
Verification
Test plan
Note
Low Risk
Documentation-only change, but it adds substantial new guidance around
eq/totAPIs and status tables; risk is limited to potential inaccuracies/misalignment with the actual implementations.Overview
Updates the Japanese TASK library manual to reflect expansion from 5 → 7 modules by adding new chapters for
eq(MHD equilibrium) andtot(orchestrator), including build steps, minimal Python examples, parameter/ABI notes (e.g.,eq_set_param_str,PSIBindexing), and test pointers.Reworks existing overview/status content to match the new scope: updates title/abstract/date, table-of-contents structure, completion matrix, remaining-work items (notably
totfan-out still stubbed), MCP server coverage, Makefile targets, PR index, and the “minimal example catalog” to includeeq/tot.Reviewed by Cursor Bugbot for commit 0abc777. Bugbot is set up for automated code reviews on this repo. Configure here.