Hacktoberfest 2026:維護者為十月標記出來的 issue,仍然開放、適合新手。 瀏覽 Hacktoberfest issue

Condition table not specified for parameters governed by rate rules

未關閉
#539 3 則留言 0 個 reaction 已指派 0 人 在 GitHub 檢視

還沒有人認領這個 Issue。

評估

難度
1/5
預估耗時
1 小時以內
新手友好度
45/100
Issue 類型
文件
描述清晰度
描述清楚
活躍度
停滯
領域
documentation

研究方向

Start at the condition-table section of documentation_data_format.html and review the current condition table description against the issue's proposed wording. Update the documentation to mention initial values of parameters governed by RateRules, then check the rendered page for clarity and formatting.

由索引模型根據 Issue 內容生成。

描述

v1

Which problem would you like to address? Please describe.
Parameters in SBML can be either constant=True or constant=False. In case of constant=False the parameter can be either governed by an AssignmentRule or a RateRule. In case of a RateRule the parameter becomes a state variable in the ODE (analoque to species and compartments which are constant=False and governed by a RateRule or in case of species by reactions).
For such parameters which are governed by RateRules a typical condition is to set the initial value of the state variable, but this is currently not mentioned in the condition table.
See also https://github.com/AMICI-dev/AMICI/issues/1750 for an example PETab problem.

Describe the solution you would like
I propose to clarify the description of the condition table, i.e.,
I.e. the more correct way for the condition table description in
https://petab.readthedocs.io/en/latest/documentation_data_format.html#condition-table
should be

The condition table specifies constant parameters, or initial values of species, compartments or parameters for specific simulation conditions (generally corresponding to different experimental conditions).

instead of

The condition table specifies parameters, or initial values of species and compartments for specific simulation conditions (generally corresponding to different experimental conditions).

Describe alternatives you have considered
An alternative is to encode the parameter as a species or compartment governed by a RateRule. While this would be supported, the semantics would be incorrect and also the units would create problems.

主要語言
沒有語言資料
星號
67
分支
16
平均合併
1 天 19 小時
30 天內合併 PR
1

環境準備

  • 沒有 Dockerfile 或 Docker Compose 檔案
  • 沒有 Pull Request 範本
  • 閱讀貢獻指南

從這裡開始

  1. 先讀完整個 Issue,再讀專案的貢獻指南。
  2. 在 Issue 下留言說明你要接手 —— 這能避免兩個人做同樣的事。
  3. Fork 儲存庫,在一個分支上完成修改。
  4. 送出 Pull Request,並在描述裡引用這個 Issue 編號。

PEtab-dev/PEtab 的其他 Issue

查看 PEtab-dev/PEtab 的全部 Issue

相似的 Issue

更多 Documentation Issue

把新 issue 寄到你的電子郵件信箱

精選適合新手參與的 GitHub issue 摘要。