ScintiPix v0.3.1

[0.3.1] - 2026-10-01

This patch release numbers the photons in the HERMES photon table in the order
they arrived.

Changed

• photons.parquet is now sorted by timestamp_canonical before photon_id
  is assigned, so a later photon_id means a later arrival, as in a real
  readout. Photons that arrived at exactly the same time keep the order the
  transported photon file holds them in (#64).
• The binary files and the primaries and simulated-photon tables keep the order
  the simulator wrote them in.

Documentation

• Replaced the v0.3.0 note that photon_id is not in order of arrival with a
  description of the sorted order. The docs also say that real HERMES data is
  up to about 100 ns out of order, which this table does not copy yet.

Known limitations

• The intensifier and sensor runtime stages are not supported end to end.
• Real HERMES data numbers photons by their earliest pixel and then corrects
  the time for brightness, so neighbouring photons can be slightly out of
  order. The simulated table is in exact time order.
• Geant4 uses fresh random seeds by default. Exact replay requires the relevant
  seeds, process setup, runtime configuration, software environment, and worker
  behavior; identical configuration files do not by themselves guarantee
  identical physics output.
• The locked environment targets Linux x86_64 and Apple Silicon macOS only.
• The mixed AmBe event model does not apply the catalog's separate gamma
  scintillation profile to coincident neutron/gamma events. This release does
  not claim pulse-shape discrimination behavior.
• Bundled lens prescriptions and reference data are unchanged from v0.2.0.

ScintiPix v0.3.0

[0.3.0] - 2026-09-24

This feature release corrects source timing in the supported OGS/AmBe example
and clarifies how photon row order relates to arrival time.

Fixed

• The OGS/AmBe example now uses continuous source timing at 2,200,000 neutrons
  per second instead of assigning every event time zero (#62).
• README release links now point to the release, source archive, and checksum.

Documentation

• Clarified that photon_id identifies a row rather than arrival order; sort
  by timestamp_canonical when time ordering is needed (#60).
• Explained how source flux sets the event spacing in the OGS/AmBe example.

Validation

• Added a regression test for the OGS/AmBe timing mode and source rate.

Known limitations

• The intensifier and sensor runtime stages are not supported end to end.
• Geant4 uses fresh random seeds by default. Exact replay requires the relevant
  seeds, process setup, runtime configuration, software environment, and worker
  behavior; identical configuration files do not by themselves guarantee
  identical physics output.
• The locked environment targets Linux x86_64 and Apple Silicon macOS only.
• The mixed AmBe event model does not apply the catalog's separate gamma
  scintillation profile to coincident neutron/gamma events. This release does
  not claim pulse-shape discrimination behavior.
• Bundled lens prescriptions and reference data retain the provenance and
  attribution notes in THIRD_PARTY_NOTICES.md and are unchanged from v0.2.0.

ScintiPix v0.2.0

ScintiPix v0.2.0

ScintiPix v0.2.0 improves installation, first-run guidance, and continuous validation while preserving the supported Geant4 and RayOptics workflow.

• 2026-09-09

This release improves installation, first-run guidance, and continuous
validation while preserving the supported Geant4 and RayOptics workflow.

Added

• Quick-install and getting-started instructions for the OGS/AmBe example.
• Published release, source archive, and checksum links in the README.
• GitHub Actions CI on Linux x86_64 and Apple Silicon macOS.

Known limitations

• The intensifier and sensor runtime stages are not supported end to end.
• Geant4 uses fresh random seeds by default. Exact replay requires the relevant
  seeds, process setup, runtime configuration, software environment, and worker
  behavior; identical configuration files do not by themselves guarantee
  identical physics output.
• The locked environment currently targets Linux x86_64 and Apple Silicon
  macOS only.
• The mixed AmBe event model currently does not apply the catalog's separate
  gamma scintillation profile to coincident neutron/gamma events. The release
  does not claim pulse-shape discrimination behavior.
• Bundled lens prescriptions and reference data are documented with their
  available provenance and attribution notes in THIRD_PARTY_NOTICES.md.

See RELEASING.md, CITATION.cff, LICENSE, and THIRD_PARTY_NOTICES.md in the source archive for details.

ScintiPix v0.1.0

ScintiPix v0.1.0

ScintiPix v0.1.0 is the first release. It provides YAML-driven Geant4 simulation, fixed-record binary output, RayOptics transport to the intensifier photocathode plane, and Python Parquet post-processing.

Included

• YAML-driven Geant4 simulation configuration with validated Pydantic models.
• Bundled lens, scintillator, and AmBe source catalogs.
• Fixed-record binary output for primary particles, secondary particles, and optical photons.
• RayOptics transport to the intensifier photocathode plane.
• Run-clock Parquet tables and an eight-column HERMES-style photon table with event truth labels.
• Examples for source timing, autofocus, catalog loading, and optical transport.

Known limitations

• Intensifier multiplication and sensor readout are not supported end to end.
• Geant4 uses fresh random seeds by default; identical configuration files do not guarantee identical physics output.
• The locked environment targets Linux x86_64 and Apple Silicon macOS.
• The mixed AmBe event model does not apply the catalog's separate gamma scintillation profile to coincident neutron/gamma events.
• The release does not claim pulse-shape discrimination behavior.

See RELEASING.md, CITATION.cff, LICENSE, and THIRD_PARTY_NOTICES.md in the source archive for details.

Changelog entry

• 2026-09-09

ScintiPix's first release. This is an early release; the intensifier and
sensor stages remain under development.

Added

• YAML-driven Geant4 simulation configuration with validated Pydantic models.
• Bundled lens, scintillator, and AmBe source catalogs.
• Fixed-record binary output for primary particles, secondary particles, and
  optical photons.
• RayOptics transport to the intensifier photocathode plane.
• Run-clock parquet tables and an eight-column HERMES-style photon table with
  event truth labels.
• Examples for source timing, autofocus, catalog loading, and optical transport.

Known limitations

• The intensifier and sensor runtime stages are not supported end to end.
• Geant4 uses fresh random seeds by default. The run log records seed messages,
  which may include multiple master and worker seed pairs. Exact replay also
  requires the relevant process setup, runtime configuration, software
  environment, and all required seeds; identical configuration files do not by
  themselves guarantee identical physics output.
• The locked environment currently targets Linux x86_64 and Apple Silicon
  macOS only.
• The mixed AmBe event model currently does not apply the catalog's separate
  gamma scintillation profile to coincident neutron/gamma events. The release
  does not claim pulse-shape discrimination behavior.
• Bundled lens prescriptions and reference data are documented with their
  available provenance and attribution notes in THIRD_PARTY_NOTICES.md.