chore(review): capture initial findings

[Liam-Deacon]

Summary by Sourcery

Documentation:

• Replace the previous comprehensive CLEED codebase review with a shorter initial-findings document focused on build/toolchain issues, modernization opportunities, testing gaps, packaging/release goals, and documentation plans.

[sourcery-ai]

Reviewer's Guide

Replaces the previous comprehensive CLEED codebase review document with a much shorter "initial findings" note focused on current build/tooling blockers, modernization opportunities, testing/regression needs, packaging/release goals, and documentation work, plus a condensed Qt4 build failure snippet and roadmap hooks.

Sequence diagram for the new lattice amoeba regression test flow

sequenceDiagram
    participant caller
    participant lattice_setup
    participant amoeba_search
    participant state_assertions

    caller->>lattice_setup: initialize_lattice_parameters
    lattice_setup-->>caller: lattice_state

    caller->>amoeba_search: run_amoeba_search(lattice_state)
    amoeba_search-->>caller: optimized_state

    caller->>state_assertions: validate_state(optimized_state)
    state_assertions-->>caller: assertion_result

    caller-->>caller: report_pass_fail(assertion_result)

Loading

Flow diagram for the updated CI build, test, and packaging pipeline

flowchart TD
    source["Source"] --> ci_build["CI Build"]
    ci_build --> unit_tests["Unit Tests"]
    unit_tests --> packaging["Packaging (Windows/MSI, Homebrew, deb/rpm, Docker)"]
    packaging --> releases["GitHub Releases Assets (installer, tarballs, Docker image)"]

Loading

File-Level Changes

Change	Details	Files
Condense the CLEED codebase review document from a long, detailed roadmap-style report into a short initial-findings guide focused on immediate issues and modernization themes.	Rename the document from "CLEED Codebase Review (Comprehensive)" to a shorter "CLEED Codebase Review" and reframe it as capturing initial findings from working on master. Remove the long executive summary, architectural overview, detailed build/licensing/GUI/testing/CI/docs sections, and appendices in favor of a smaller set of focused sections. Introduce a new "Build and toolchain" section capturing current CMake/Qt4 macOS failure symptoms, severity classification, and recommended actions. Add a "Modernization opportunities" section summarizing Qt6 migration, image codec updates, and Numerical Recipes replacement, with a small table of components vs suggested alternatives. Add a "Testing and regression protection" section calling out missing tests and refactor needs for amoeba search tests and lattice behavior. Add a "Packaging, automation, and releases" section describing target packaging formats and a concise ASCII release pipeline. Add a "Documentation and Sphinx" section recommending manual conversion and CI-backed Sphinx/ReadTheDocs integration. End with an "Immediate next steps" checklist to convert findings into GitHub issues and concrete follow-up work.	docs/codebase-review.md

---

Tips and commands

Interacting with Sourcery

• Trigger a new review: Comment @sourcery-ai review on the pull request.
• Continue discussions: Reply directly to Sourcery's review comments.
• Generate a GitHub issue from a review comment: Ask Sourcery to create an
  issue from a review comment by replying to it. You can also reply to a
  review comment with @sourcery-ai issue to create an issue from it.
• Generate a pull request title: Write @sourcery-ai anywhere in the pull
  request title to generate a title at any time. You can also comment
  @sourcery-ai title on the pull request to (re-)generate the title at any time.
• Generate a pull request summary: Write @sourcery-ai summary anywhere in
  the pull request body to generate a PR summary at any time exactly where you
  want it. You can also comment @sourcery-ai summary on the pull request to
  (re-)generate the summary at any time.
• Generate reviewer's guide: Comment @sourcery-ai guide on the pull
  request to (re-)generate the reviewer's guide at any time.
• Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
  pull request to resolve all Sourcery comments. Useful if you've already
  addressed all the comments and don't want to see them anymore.
• Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
  request to dismiss all existing Sourcery reviews. Especially useful if you
  want to start fresh with a new review - don't forget to comment
  @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

• Enable or disable review features such as the Sourcery-generated pull request
  summary, the reviewer's guide, and others.
• Change the review language.
• Add, remove or edit custom review instructions.
• Adjust other review settings.

Getting Help

• Contact our support team for questions or feedback.
• Visit our documentation for detailed guides and information.
• Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

[sourcery-ai]

Hey there - I've reviewed your changes - here's some feedback:

• By collapsing the original detailed sections (e.g., NR-derived file list, unsafe API call sites, concrete CMake failure logs) into a higher-level summary, the new document loses some immediately actionable context; consider either retaining those specifics in an appendix or linking directly to the corresponding GitHub issues from this overview.
• The new Qt/modernization section is quite general compared to the previous concrete cmake_minimum_required and enable_language(RC) guidance; it would help future work to keep at least a brief note on the exact build flags and CMake policies that are currently failing.
• In the testing section you mention refactoring tests/test_search_amoeba and adding boundary tests for n_bas, but the doc doesn’t clearly tie these to specific modules or functions as the prior roadmap did; adding a short mapping from these suggestions to file/function names would make the guidance more immediately actionable.

Prompt for AI Agents

Please address the comments from this code review:

## Overall Comments
- By collapsing the original detailed sections (e.g., NR-derived file list, unsafe API call sites, concrete CMake failure logs) into a higher-level summary, the new document loses some immediately actionable context; consider either retaining those specifics in an appendix or linking directly to the corresponding GitHub issues from this overview.
- The new Qt/modernization section is quite general compared to the previous concrete `cmake_minimum_required` and `enable_language(RC)` guidance; it would help future work to keep at least a brief note on the exact build flags and CMake policies that are currently failing.
- In the testing section you mention refactoring `tests/test_search_amoeba` and adding boundary tests for `n_bas`, but the doc doesn’t clearly tie these to specific modules or functions as the prior roadmap did; adding a short mapping from these suggestions to file/function names would make the guidance more immediately actionable.

---

Sourcery is free for open source - if you like our reviews please consider sharing them ✨

• X
• Mastodon
• LinkedIn
• Facebook

_{Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.}

[codacy-production]

Codacy's Analysis Summary

1 new issue (≤ 0 issue)
0 new security issue

Review Pull Request in Codacy →

✨ AI Reviewer available: add the codacy-review label to get contextual insights without leaving GitHub.