Skip to content

v0.23.0 — Formal manuscripts and Word author collaboration

Choose a tag to compare

@Xiuyiw Xiuyiw released this 20 Oct 05:26
02d994f

v0.23.0 — Formal manuscripts and Word author collaboration

This release connects the research workspace to an editable manuscript, an author's Word return,
and a fresh candidate with current scientific values. Analysis definitions, evidence tokens,
figures and native equations continue to use the existing research pipeline.

What changes for the author

  • Paragraphs, figures, captions, tables and equations have a shared order and stable identity.
    DOCX, Markdown and LaTeX use this common scientific content.
  • cfdpaper author prepares a Word manuscript and recovers ordinary prose, captions, supported
    local formatting and anchored comments. The original return is kept alongside the new source
    candidate. Non-overlapping edits merge; conflicting edits retain both versions for resolution.
  • Local Figure/Fig. presentation follows subsequent numbering. A clear whole-sentence removal
    can remove its binding; changing a number is not treated as a scientific source update.
  • research --author-candidate carries recovered local-ID drafts and presentation into the
    existing research workspace. Current source definitions and author-local plotting scripts drive
    recalculation and redrawing, rather than being replaced by the Word file.
  • Research, report and conference profiles share scientific facts. Word retains native tables
    and equations; LaTeX keeps figures with their captions and separates table notes from bottom rules.

Try the complete public example

Install the wheel with the docs extra and run
examples/author-collaboration/run_example.py
from any writable directory. It starts with analytical pipe-pressure CSV rows, prepares Word,
demonstrates a clearly attributed automated edit/comment, changes the source viscosity and recovers
the wording with the new pressure values. No solver or external model service is required.

python -m pip install "cfd_paper_agent-0.23.0-py3-none-any.whl[docs]"
python /path/to/author-collaboration/run_example.py /path/to/new-output

The source-distribution and public-examples archive include the runnable example.

Real-task use

The retained cooling study was exercised with the author's actual Word edits and comment, then
with isolated source-value and observation-definition changes. The original results, manuscript
and plotting scripts were preserved. Research and template-based Word outputs were opened in
Word and inspected as rendered pages. A conference view was actually compiled using the official
IEEEtran class through a local bridge; this is a template exercise, not an IEEE submission claim.

The author edits exposed and helped fix copied figure locators, Word-localized style identities,
reference abbreviations and complete bound-clause deletions. The research workspace now provides
an explicit continuation route rather than requiring the host to paste all recovered prose back.

Software verification

The release is checked with the full test suite on Windows and Linux using Python 3.10–3.12,
plus lint/format checks and a clean-wheel installation replay. The public example is run outside
the checkout, without editable imports. Current run details are available in
GitHub Actions.
The release assets contain the wheel, source distribution and portable public examples with
rendered research/report previews.

Scope

Word return is a managed, bounded collaboration route, not arbitrary lossless DOCX conversion.
Numerical cells, formulas, citation fields, modified image content, ambiguous anchors and
unaccepted tracked changes require object-specific resolution. Ordinary comments are suggestions,
not approval. Numerical/definition changes identify affected interpretations; the host and author
still decide how to revise mechanisms, conclusions and literature comparisons.

Word template import uses named styles and final-section geometry. Legacy template compatibility
and automatic caption numbering are handled in the generated copy; arbitrary multi-section
publisher layouts are not reproduced. A profile is not evidence of journal compliance or
scientific readiness. Existing v0.22 scientific analyses and native-backend scope remain unchanged.

Verified CI: https://github.com/Xiuyiw/CFD-SCIPaper-Agent/actions/runs/39370692394

Source: 02d994f8a6affcf3981425a6a5996ada35b4d8a0 (same source tree as the verified PR build).