Skip to content

Add symmetrization conventions report - #36

Open
mmikhasenko wants to merge 2 commits into
mainfrom
codex/report-appendix-audit
Open

Add symmetrization conventions report#36
mmikhasenko wants to merge 2 commits into
mainfrom
codex/report-appendix-audit

Conversation

@mmikhasenko

@mmikhasenko mmikhasenko commented Jul 16, 2026

Copy link
Copy Markdown
Contributor

Summary

  • add a standalone Quarto report on permutation, charge-conjugation, and symmetrization conventions
  • document explicit recipes and cross-checks for identical-particle amplitude models
  • include worked notes for three-pion, Xi_b -> p K K, J/psi -> eta p pbar, B_s -> J/psi p pbar, and chi_c -> K K pi pi cases
  • include a technical appendix, convention ledger, references, and report styling

Motivation

Amplitude models with identical particles need explicit, auditable conventions
for label permutations, exchange phases, charge conjugation, and coherent sums.
This report collects those conventions and their case-by-case checks in one
renderable reference.

Validation

  • rendered all 13 report pages with quarto render symmetry_report
  • confirmed the generated report entry point is symmetry_report/_report/index.html
  • confirmed the branch contains no pp -> pp K+ K- tutorial changes

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request adds pre-rendered static examples and a comprehensive Quarto-based report on discrete symmetries in cascade decays to the documentation. It introduces a new amplitude model example for $pp \to p_1 p_2 K^+ K^-$ along with its Julia environment, Quarto notebook, and Markdown files, and updates the documentation build script to copy these static examples. The review feedback recommends using force = true when copying assets in the build script to prevent transient failures, adding [compat] bounds for all dependencies in the examples environment to ensure reproducibility, and using explicit multiplication instead of implicit multiplication in the example code.

Important

The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.

Comment thread docs/make.jl Outdated
isdir(source_assets) || error(
"missing rendered example assets $(source_assets); see examples/README.md for regeneration instructions",
)
cp(source_assets, joinpath(dirname(destination), spec.asset_dir))

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

Using force = true when copying directories in build scripts is a safer defensive programming practice to prevent transient build failures if the destination directory already exists or was not fully cleaned up.

    cp(source_assets, joinpath(dirname(destination), spec.asset_dir); force = true)

Comment thread examples/Project.toml Outdated
Comment on lines +14 to +15
[compat]
julia = "1.11"

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

It is highly recommended to specify [compat] bounds for all dependencies in examples/Project.toml (such as DataFrames, Plots, ThreeBodyDecays, etc.) to ensure long-term reproducibility of the examples and prevent future breaking releases of these packages from breaking the build.

Comment thread examples/pp2ppKK-model.qmd Outdated
c_lambda1520=5.0 + 0.0im,
)

@assert settings.sqrt_s > 2particles.proton + 2particles.kaon

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

Using implicit multiplication like 2particles.proton can be confusing or look like a typo. It is clearer and more idiomatic to write explicit multiplication 2 * particles.proton.

@assert settings.sqrt_s > 2 * particles.proton + 2 * particles.kaon

Comment thread examples/pp2ppKK-model.md Outdated
c_lambda1520=5.0 + 0.0im,
)

@assert settings.sqrt_s > 2particles.proton + 2particles.kaon

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

Using implicit multiplication like 2particles.proton can be confusing or look like a typo. It is clearer and more idiomatic to write explicit multiplication 2 * particles.proton.

Suggested change
@assert settings.sqrt_s > 2particles.proton + 2particles.kaon
@assert settings.sqrt_s > 2 * particles.proton + 2 * particles.kaon

@mmikhasenko
mmikhasenko force-pushed the codex/report-appendix-audit branch from 7ad973c to 4897dda Compare July 16, 2026 11:53
@mmikhasenko mmikhasenko changed the title [DRAFT] Report appendix audit Add symmetrization conventions report Jul 16, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant