ClearPlan v3.2.0 - Configurable review and synthetic Technical Note

ClearPlan v3.2.0

Software and author-review Technical Note materials are associated with the
v3.2.0 release.
The verified application source revision is
ca3e381813489542bae4551db9db23c8c3da23d8; publication-only changes add manuscript,
figures, evidence and document-generation tooling. This is not an accepted paper,
a clinical installer, or clinical commissioning. Historical v3.1.0 records are
retained separately rather than reused as evidence for this version.

Scope

• Shared read-only plan review with safer structure mapping, explicit target
  coverage, focused interactive DVHs, shared structure visibility and default
  hiding of unmatched rows without removing the mapping editor.
• Target-specific PAM with explicit single-/dual-layer MLC profiles, Paddick CI
  and its reciprocal, GI/HI, total MU and separately labeled estimated dose-rate
  trajectories. Unsupported or incomplete inputs remain unavailable.
• A separate comparison reference, three CT planes with dose/structure overlays,
  optional field-start BEV/DRR panels, compact active-plan PDF and offline HTML
  quicklook. The active-plan report is not a comparison report.
• Versioned external configuration for aliases, defaults, field nomenclature,
  constraints, target rules and enabled checks, including author/time/hash
  history and restore-as-new-revision.
• Seven retained baseline/fault scenarios plus two generated publication
  phantoms. The latter share analytic anatomy/dose definitions across displays
  and numerical checks; dose is not calculated from the MLC apertures.
• Optional, disabled-by-default ARIA report-document transfer, separate from
  read-only treatment-plan access. Sparse readback may use explicitly configured
  restricted UNC roots to compare the stored PDF bytes; metadata alone is not
  full verification. Local configuration and interoperability evidence remain
  private and require separate approval.

The Stock 2024 workbook remains editable example configuration, not a clinical
recommendation: its current inspected inventory is eight tables, 495 executable
rules and 70 canonical structures. Table confirmation and local review are
required. The smaller original example workbook remains available.

The illustrative RayStation adapter demonstrates the neutral snapshot boundary;
it is not a commissioned implementation of every metric. This
repository's Essentials wrapper is also distinct from a separately deployed
institutional Runner Hub.

Reproduce the software checks

Follow reproducibility. The public entry point accepts
an explicit Python executable:

.\tools\build-public-release.ps1 -Version 3.2.0 `
  -PythonExecutable python

Run under an approved execution policy. -DevelopmentPreview and
-SkipSimulatorSmoke are explicitly incomplete verification modes, not the final
release gate. No proprietary TPS runtime is required for these public tests.

Core/contract, locked synthetic DICOM, illustrative RayStation and stock tests
are separate evidence scopes. Their actual totals, failed/skipped counts,
timestamps and tested-input hashes belong in the current execution receipt, not
as fixed numbers copied into this page. The private stock-source transcription
class is absent from a clean public checkout and is explicitly skipped; parser
tests and the distributed-XLSX loader regression still execute.

Evidence and publication boundary

Use the release manifests and receipts for exact source commits, artifact
hashes, file inventories and measured environment versions. No older version's
hash or workstation record is a substitute.

1. Reviewed public source/configuration manifest with exact-byte hashes, original
   licenses and a documented relationship to the evaluated checkout.
2. Fresh public build and execution receipt
   (artifacts/public-release-test-evidence.json), including separate suite
   results and honest skips. Working-tree changes must be accounted for by the
   source manifest rather than concealed behind a HEAD commit label.
3. Verified simulator runtime/package inventory and matching hashes from repeated
   packaging. Repackaging one build is not an independent clean-build experiment.
4. A separate patient-free publication manifest: reviewed GUI figures, PDF/HTML
   examples, manuscript, references and traceability. Software-test success does
   not imply visual QA or manuscript acceptance.
5. Independent readback of the newly published tag/commit and downloaded assets,
   matched to their final manifests and SHA-256 values. Release publication is
   not complete merely because source metadata names v3.2.0.

The paper's paper/evidence/technical_note_evidence.json records an actual run
from the frozen software revision. Its collection-time publication state is kept
unchanged; the collector does not attest to a later GitHub publication. The
release's separate publication/readback manifest supplies the tag and asset
bindings. Protected native snapshots, reports,
FHIR receipts, source workbooks and local credentials never enter the public
source or publication manifest.

Acceptance boundary

No clinical sensitivity, specificity, delivered-dose accuracy or universal
constraint applicability is established by the synthetic fixtures. Native TPS
interoperability, installed machine profiles, ARIA transfer and clinical workflow
acceptance require local controlled verification. Use the
commissioning scaffold,
analysis method and
ARIA guide as scoped implementation aids, not as
clinical approval.

ClearPlan v3.1.0

ClearPlan v3.1.0

ClearPlan v3.1.0 is the simulator-backed technical-note release. It provides a
patient-free way to inspect the integrated plan-review interface and preserves
a separate locally built Eclipse/ESAPI mode.

Highlights

• Vendor-free Windows x64 simulator with seven deterministic synthetic
  scenarios
• Integrated overview plus focused PQM, PlanCheck, field-name, and wide DVH
  pages
• Read-only field-ID and PlanFieldNamer-compatible name conformance, including
  couch-before-direction ordering such as 179-181 T30 UZ
• RefDB JSON and Excel workbook sources normalized into one validated catalog
• Bounded optional network-source loading and last-valid workspace retention
• Versioned neutral ReviewSnapshot used by the simulator and Eclipse host
• Illustrative, unvalidated, read-only RayStation adapter example
• Reproducible ZMP Short Communication manuscript, three synthetic figures,
  and machine-readable evidence
• Proposed local commissioning scaffold that clearly separates public
  regression fixtures from site-specific clinical acceptance

Verification

• 125 C# tests, zero failures
• 20 Python RayStation-example tests, zero failures
• Python fake-context export accepted by the C# snapshot validator with zero
  issues
• Seven simulator scenarios validated
• Deterministic UI captures and DVH export verified
• Synthetic PDF report generated and validated
• Cross-runtime deterministic ZIP verified with Windows PowerShell 5.1 and
  PowerShell 7.4
• Public workbook validated: 3 tables, 19 constraints, 7 structures
• Source, settings, Office XML, vendor-dependency, version, and privacy guards
  passed

Start modes

The attached ClearPlan-Simulator-v3.1.0-win-x64.zip runs without Eclipse,
ESAPI, proprietary TPS assemblies, or patient data. Start
ClearPlan.Simulator.exe and select a scenario, or pass
--scenario mixed-review.

The Eclipse/ESAPI runner remains a separate local build. It requires
institution-approved vendor assemblies, a locally commissioned constraint
catalog and PlanCheck implementation, and site-specific validation. Licensed
vendor assemblies are not included in this release.

The RayStation adapter under examples/raystation is an illustrative contract
example only. It has not been runtime-validated or clinically commissioned.

Evidence boundary

All results in the technical note are deterministic and synthetic. This
release does not establish clinical sensitivity, specificity, false-positive
rate, workflow efficiency, error reduction, or patient-safety benefit.

The .sha256 asset contains the SHA-256 checksum of the simulator archive.

ClearPlan v2.9.3.1

ClearPlan v2.9.3.1

ClearPlan is an open-source framework for automated radiotherapy plan review that integrates plan quality metric evaluation, DVH visualization, structured reporting, and failure-mode logging.

This first public starter release is designed as a readable, extensible baseline for institution-specific implementation, collaborative development, and research dissemination.

Highlights

• Added a human-readable settings.json with local default paths for templates, logs, reports, exports, and state files.
• Simplified the default ErrorCalculator to a small set of general starter checks instead of clinic-specific nomenclature or network-dependent rules.
• Added three lean starter PQM tables for conventional plans, hypofractionated plans, and plan sums.
• Reworked the Help menu so Change Log and Feedback are directly usable in public distributions.
• Added community-facing repository guidance, issue templates, and citation metadata.

Important setup note

Public users still need institution-approved copies of:

• VMS.TPS.Common.Model.API.dll
• VMS.TPS.Common.Model.Types.dll

These vendor-specific ESAPI assemblies are not tracked in the public repository and must be provided locally before building.