unzhakov/beta_shape_pnpi
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: prune research vault to theory-only scope

Browse Source 
Remove gA-extraction notes, nuclear-structure notes, paper-summary
refs, detector-response correction note and the finished test
migration checklist. Rewrite the vault index for the single-package
theory calculator; repoint dangling wiki-links in surviving notes to
inline citations; refresh docs_check.py (drop bs_exp CLI check,
register removed files).

Literature and nuclear-structure research resumes in dedicated
projects; the removed notes are recoverable from history.
This commit is contained in:
unzhakov
2026-10-05 22:53:47 +03:00
parent 6aced1d8ac
commit dc8e26403b
25 changed files with 57 additions and 4310 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/README.md
+10 -31
View File
@@ -8,17 +8,13 @@ status: active
# Beta Spectrum Calculator — Knowledge Base
This Obsidian vault serves as the scientific reference and development workspace for the **beta-spectrum calculator** project (`beta_shape_pnpi`).
This Obsidian vault is the scientific reference behind the **beta-spectrum shape calculator** (`beta_spectrum`). Since v0.5.0 the repository is dedicated solely to high-precision spectrum-shape *calculation*: detector response, data calibration, and fitting/extraction analyses are separate projects, and their literature was removed from this vault.
## Purpose
Organize the physics theory behind β-decay spectrum calculations into structured, interconnected notes that inform the implementation of correction components in the codebase.
## Source Material
| Reference | Type | Location |
|---|---|---|
| Hayen et al., *Rev. Mod. Phys.* **90**, 015008 (2017) | Review article | [[refs/electromagnetic/2017_Hayen_analytical_beta_shape/summary]] |
Key external references (cited inline in the notes): Hayen et al., *Rev. Mod. Phys.* **90**, 015008 (2018); Sirlin (1967–2011); Hayen et al., *J. Phys. G* (2019) on first-forbidden transitions. Nuclear-structure shape-factor theory is external to this repository.
## Directory Structure
@@ -27,6 +23,7 @@ docs/
├── README.md ← You are here
├── 00-beta-spectrum-overview.md ← Master equation & full correction list
├── 02-phase-space.md ← Baseline spectral shape
├── test-architecture.md ← Test organization & strategy
├── corrections/ ← All correction components
│ ├── 01-fermi-function.md ← Fermi function F₀(Z,W)
│ ├── 02-finite-size.md ← Nuclear size: L₀, U, DFS
@@ -34,21 +31,9 @@ docs/
│ ├── 04-exchange.md ← Atomic exchange X(Z,W)
│ ├── 05-radiative.md ← Outer radiative R(W,W₀)
│ ├── 06-recoil.md ← Recoil: R_N, Q, weak magnetism
│ ├── 07-detector-response.md ← Detector convolution
│ ├── 08-atomic-overlap.md ← Atomic mismatch r(Z,W)
│ └── 09-chemical-effects.md ← Molecular environment
├── nuclear-structure/ ← Nuclear theory
│ ├── index.md ← Overview
│ └── 01-shape-factors.md ← C(Z,W), NMEs, impulse approximation
├── gA-extraction/ ← gA extraction (new, in development)
│ ├── 01-ssm-algorithm.md ← SSM step-by-step algorithm
│ ├── 02-ssnme.md ← sNME and ESSM formalism
│ ├── 03-tc99-case-study.md ← 99Tc literature results
│ └── 04-implementation-todo.md ← Implementation TODO list
└── refs/ ← Paper summaries
├── electromagnetic/ ← CVC, radiative corrections
├── forbidden-decay/ ← Forbidden decay studies
└── (organized by topic)
└── (refs removed; literature research resumes in dedicated projects)
```
## Calculator Architecture
@@ -62,10 +47,10 @@ SpectrumComponent (ABC, base.py)
├── ScreeningCorrection → corrections/03-screening.md
├── ExchangeCorrection → corrections/04-exchange.md
├── RadiativeCorrection → corrections/05-radiative.md
└── (recoil.py) → corrections/06-recoil.md (not yet implemented)
└── (recoil component) → corrections/06-recoil.md (not yet implemented)
BetaSpectrum (spectrum.py) — multiplicative composition + from_config()
BetaSpectrumAnalyzer (spectrum.py) — plotting, CSV export
BetaSpectrumAnalyzer (output/core.py) — plotting, CSV export
```
## Correction Implementation Status
@@ -79,15 +64,9 @@ BetaSpectrumAnalyzer (spectrum.py) — plotting, CSV export
| 5 | Exchange | `exchange.py` | Atomic exchange | ✓ implemented |
| 6 | Radiative | `radiative.py` | Outer RC | ✓ implemented |
| 7 | Recoil | `recoil.py` | R_N, Q, weak magnetism | ✗ not yet implemented |
| 8 | Shape factor | `shape_factor_gA.py` | C(Z,W) for forbidden | — planned |
| 9 | Detector | `detector_response.py` | Convolution | — planned |
## gA Extraction (New)
For forbidden nonunique decays (e.g., $^{99}\text{Tc}$), the shape factor depends on $g_A$ in a measurable way. See:
- [[gA-extraction/01-ssm-algorithm]] — The SSM algorithm for extracting $g_A$ from spectral shapes
- [[gA-extraction/04-implementation-todo]] — Step-by-step implementation plan
| 8 | Shape factor | — | C(Z,W) is an input parameter (external nuclear-structure theory) | out of scope |
| 9 | Atomic overlap | — | r(Z,W) | documentation only |
| 10 | Chemical effects | — | molecular environment | documentation only |
## Key Variables and Units
@@ -102,4 +81,4 @@ Conversion: $W = 1 + T / m_e c^2$, with $m_e c^2 = 510.998950$ keV.
## Precision Goal
The calculator aims for **accurate to a few parts in $10^{-4}$ down to 1 keV** for low-to-medium $Z$ nuclei, following the approach of Hayen et al. (2017).
The calculator aims for **accurate to a few parts in $10^{-4}$ down to 1 keV** for low-to-medium $Z$ nuclei, following the approach of Hayen et al. (2018).