Skip to content

Commit db4d62d

Browse files
authored
Update README.md
1 parent 1743adf commit db4d62d

File tree

1 file changed

+74
-15
lines changed

1 file changed

+74
-15
lines changed

README.md

Lines changed: 74 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -8,47 +8,106 @@
88
https://colab.research.google.com/github/geopayme/AstroPhysics/blob/main/DLSFH_Entropy_Diagnostic_NOAA.ipynb
99
)
1010

11-
This release package accompanies the paper:
11+
This repository accompanies the paper:
1212

1313
**_Entropy Rings and Fragmented Suns: A New Approach to Flare and CME Risk Detection_**
1414
Antonios Valamontes, Kapodistrian Academy of Science
1515

1616
It contains the computational materials required for **transparent, auditable reproduction** of the paper’s diagnostic framework: a 20-node DLSFH partition of solar magnetograms, localized Shannon entropy estimation, coherence amplitude $\psi^\star_s = \exp(-S)$, SGCV fragmentation detection, entropy-ring identification via the DLSFH adjacency graph, and the composite flare/CME risk score $\(R_{\mathrm{flare}}\)$.
1717

18-
The repository is intended to support **method verification and qualitative robustness assessment**, not operational deployment.
18+
The repository supports **method verification, qualitative robustness assessment, and exploratory interpretation**. It is not an operational forecasting system.
1919

2020
---
2121

2222
## Contents
2323

2424
### Notebooks (source of truth)
2525

26-
In this repository, “source of truth” denotes the authoritative computational implementations from which the figures, diagnostics, and numerical results reported in the paper are generated. All analyses shown in the manuscript can be reproduced directly by executing these notebooks; derived figures or summaries should be treated as secondary to the notebook outputs.
26+
In this repository, **“source of truth”** denotes the authoritative computational implementations from which the figures, diagnostics, and numerical results reported in the paper are generated.
2727

28-
The canonical analysis notebooks are hosted in the associated GitHub repository:
28+
#### Core reproducibility and analysis
2929

30-
1. `DLSFH_Entropy_Diagnostic_NOAA.ipynb`**Primary reproducibility pipeline**
31-
2. `DLSFH_PhysicsEntropy_Enhanced.ipynb`**Sensitivity / robustness exploration**
32-
3. `DLSFH_PhysicsEntropy_AdvancedFinal_FINAL_5.ipynb`**Extended physics interpretation (exploratory)**
30+
1. `DLSFH_Entropy_Diagnostic_NOAA.ipynb`
31+
**Canonical end-to-end pipeline**: magnetogram partitioning, entropy extraction, coherence computation, fragmentation detection, entropy-ring identification, and risk scoring.
3332

34-
Because this ZIP is designed to be portable, it includes a **manifest** and a **fetch script** to retrieve the latest notebook copies from GitHub when internet access is available:
33+
2. `DLSFH_Entropy_AutoAnalysis_Patched.ipynb`
34+
Automated batch-style execution of the entropy–coherence pipeline with patched robustness handling. Used for repeated frame analysis and consistency checks.
3535

36-
- `manifest/notebooks.json`
37-
- `tools/fetch_notebooks.py`
36+
3. `Complete_DLSFH_Dual_Overlay_Test.ipynb`
37+
Validation notebook demonstrating geometric alignment between DLSFH node placement and NOAA active-region overlays.
38+
39+
#### Sensitivity, robustness, and interpretation
40+
41+
4. `DLSFH_PhysicsEntropy_Enhanced.ipynb`
42+
Sensitivity and robustness exploration (coherence threshold variation, entropy binning effects, node-level trend stability).
43+
44+
5. `DLSFH_PhysicsEntropy_AdvancedFinal_FINAL.ipynb`
45+
Exploratory and interpretive analysis motivated by the DLSFH/SGCV framework. Not required to reproduce operational diagnostics.
3846

3947
---
4048

4149
## Execution order
4250

43-
- **Reproduce the paper’s core results:** `DLSFH_Entropy_Diagnostic_NOAA.ipynb`
44-
- **Sensitivity & robustness:** `DLSFH_PhysicsEntropy_Enhanced.ipynb`
45-
- **Exploratory theory (optional):** `DLSFH_PhysicsEntropy_AdvancedFinal_FINAL_5.ipynb`
51+
Recommended execution order depends on intent:
52+
53+
### Reproduce the paper’s core results
54+
1. `DLSFH_Entropy_Diagnostic_NOAA.ipynb`
55+
56+
### Validate geometry and overlays
57+
2. `Complete_DLSFH_Dual_Overlay_Test.ipynb`
58+
59+
### Automated or repeated analyses
60+
3. `DLSFH_Entropy_AutoAnalysis_Patched.ipynb`
61+
62+
### Sensitivity and robustness
63+
4. `DLSFH_PhysicsEntropy_Enhanced.ipynb`
4664

47-
See `RUN_ORDER.md` for details.
65+
### Exploratory theoretical interpretation (optional)
66+
5. `DLSFH_PhysicsEntropy_AdvancedFinal_FINAL.ipynb`
67+
68+
See `RUN_ORDER.md` for concise guidance.
4869

4970
---
5071

5172
## Environment requirements
5273

5374
- Python 3.10+
54-
- Jupyter Notebook or JupyterLa
75+
- Jupyter Notebook or JupyterLab
76+
- Standard scientific Python stack
77+
78+
Environment specifications:
79+
- `requirements.txt` (pip)
80+
- `environment.yml` (conda, optional)
81+
82+
Step-by-step instructions and expected outputs are documented in `REPRODUCIBILITY.md`.
83+
84+
---
85+
86+
## Data sources
87+
88+
All analyses rely on **publicly available solar magnetogram data**, including NOAA and NSO/GONG products. No proprietary datasets are required.
89+
90+
---
91+
92+
## Citation and archiving
93+
94+
Formal citation metadata and archival information are provided in:
95+
96+
- `CITATION.cff`
97+
- `zenodo.json`
98+
99+
A versioned Zenodo DOI is minted upon release to ensure long-term traceability.
100+
101+
---
102+
103+
## License
104+
105+
See `LICENSE`.
106+
107+
---
108+
109+
## Contact
110+
111+
Antonios Valamontes
112+
Kapodistrian Academy of Science
113+
Email: avalamontes@Kapodistrian.edu.gr

0 commit comments

Comments
 (0)