OpenSite/Reference/Commands/Recompute a document: Difference between revisions
BathAfrica (talk | contribs) Use BathAfrica sidebar contents without duplicate inline contents box |
BathAfrica (talk | contribs) Link adjacent OpenSite reference pages in reading order |
||
| (One intermediate revision by the same user not shown) | |||
| Line 1: | Line 1: | ||
__NOTOC__ | __NOTOC__ | ||
{{OpenSite scope}} | |||
{{BathAfrica Command | {{BathAfrica Command | ||
|id=cli.document.recompute | |id=cli.document.recompute | ||
|summary=Recompute derived quantities and save the document. | |summary=Recompute derived quantities and save the document. | ||
| Line 14: | Line 14: | ||
}} | }} | ||
== Try this workflow == | |||
[[OpenSite/Guides/First document|First document]] — a worked lesson with expected results. | |||
== Documentation basis == | == Documentation basis == | ||
| Line 25: | Line 28: | ||
[[OpenSite|OpenSite overview]] · [[OpenSite/Reference|Reference]] · [[OpenSite/Guides|Guides]] | [[OpenSite|OpenSite overview]] · [[OpenSite/Reference|Reference]] · [[OpenSite/Guides|Guides]] | ||
[[Category:OpenSite documentation]] | [[Category:OpenSite documentation]] | ||
<div class="os-page-nav">{{Docnav|OpenSite/Reference/Commands/Inspect a document|OpenSite/Reference/Commands/Set a quantity|OpenSite/Guides|All guides}}</div> | |||
Latest revision as of 14:14, 29 October 2026
Recompute derived quantities and save the document.
- Stable identifier
cli.document.recompute
Implementation milestone
Roadmap phase 1 (historical Phase 1).
Units
Derived section results stay in canonical SI.
Terminal example
Python access
The registered command is document.recompute and it takes a document handle. No Python example calls it. The CLI test does.
Output
Stdout is the inspected document. Current section results print validity current.
Errors
Exit 1 when load, recompute, or save fails. The status message is on stderr.
Limitations
Recompute does not run a solver. An evaluator exception marks derived values invalid. It does not abort the process.
Verification evidence
Repository evidence references (not rerun for this publication): CTest cli.document and document.engine.
Try this workflow
First document — a worked lesson with expected results.
Documentation basis
Source-reviewed against development commit 77c3fee13944bcc4b5d487c77eb1f82fbe4c6ea7, branch feature/phase-13c-properties-python-expressions. This review inspected the implementation and repository evidence; it did not run the Windows application or repeat CTest.
src/cli/main.cppsrc/cli/document_commands.cppsrc/cli/preference_commands.cppsrc/application/builtins.cpp