Skip to content

Commit 13e87da

Browse files
authored
Enhance README with badges and execution details
Added badges for GitHub, Zenodo, Python version, license, and Colab integration. Updated notebook execution order and environment requirements sections.
1 parent 70a0404 commit 13e87da

File tree

1 file changed

+16
-59
lines changed

1 file changed

+16
-59
lines changed

README.md

Lines changed: 16 additions & 59 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,19 @@
11
# DLSFH Entropy & Coherence Diagnostics for Solar Flare and CME Risk
22

3+
[![GitHub Repository](https://img.shields.io/badge/GitHub-dlsfh--entropy--rings--solar--risk-black?logo=github)](https://github.com/geopayme/AstroPhysics)
4+
[![Zenodo DOI](https://img.shields.io/badge/Zenodo-DOI%20pending-blue?logo=zenodo)](#)
5+
[![Python](https://img.shields.io/badge/Python-3.10%2B-blue?logo=python)](#)
6+
[![License: MIT](https://img.shields.io/badge/License-MIT-green)](LICENSE)
7+
[![Open in Colab](https://colab.research.google.com/assets/colab-badge.svg)](
8+
https://colab.research.google.com/github/geopayme/AstroPhysics/blob/main/DLSFH_Entropy_Diagnostic_NOAA.ipynb
9+
)
10+
311
This release package accompanies the paper:
412

513
**_Entropy Rings and Fragmented Suns: A New Approach to Flare and CME Risk Detection_**
614
Antonios Valamontes, Kapodistrian Academy of Science
715

8-
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}}\)$.
16+
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}}\).
917

1018
The repository is intended to support **method verification and qualitative robustness assessment**, not operational deployment.
1119

@@ -18,13 +26,8 @@ The repository is intended to support **method verification and qualitative robu
1826
The canonical analysis notebooks are hosted in the associated GitHub repository:
1927

2028
1. `DLSFH_Entropy_Diagnostic_NOAA.ipynb`**Primary reproducibility pipeline**
21-
End-to-end implementation of the entropy–coherence diagnostic: node partitioning, entropy extraction, coherence computation, fragmentation and entropy-ring detection, and risk scoring.
22-
2329
2. `DLSFH_PhysicsEntropy_Enhanced.ipynb`**Sensitivity / robustness exploration**
24-
Parameter variation (e.g., coherence threshold, entropy binning) and qualitative stability checks.
25-
26-
3. `DLSFH_PhysicsEntropy_AdvancedFinal_FINAL_5.ipynb`**Extended physics interpretation (exploratory)**
27-
Non-operational analyses motivated by the DLSFH/SGCV framework; not required to reproduce the core diagnostic results.
30+
3. `DLSFH_PhysicsEntropy_AdvancedFinal_FINAL_5.ipynb`**Extended physics interpretation (exploratory)**
2831

2932
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:
3033

@@ -35,61 +38,15 @@ Because this ZIP is designed to be portable, it includes a **manifest** and a **
3538

3639
## Execution order
3740

38-
Recommended notebook execution order depends on intent:
39-
40-
- **Reproduce the paper’s core results:**
41-
Run `DLSFH_Entropy_Diagnostic_NOAA.ipynb`.
41+
- **Reproduce the paper’s core results:** `DLSFH_Entropy_Diagnostic_NOAA.ipynb`
42+
- **Sensitivity & robustness:** `DLSFH_PhysicsEntropy_Enhanced.ipynb`
43+
- **Exploratory theory (optional):** `DLSFH_PhysicsEntropy_AdvancedFinal_FINAL_5.ipynb`
4244

43-
- **Examine sensitivity and robustness:**
44-
Then run `DLSFH_PhysicsEntropy_Enhanced.ipynb`.
45-
46-
- **Explore extended theoretical interpretation (optional):**
47-
Run `DLSFH_PhysicsEntropy_AdvancedFinal_FINAL_5.ipynb`.
48-
49-
A concise execution guide is provided in `RUN_ORDER.md`.
45+
See `RUN_ORDER.md` for details.
5046

5147
---
5248

5349
## Environment requirements
5450

55-
- Python 3.10+ recommended
56-
- Jupyter Notebook or JupyterLab
57-
- Standard scientific Python stack
58-
59-
Two environment specifications are provided:
60-
61-
- `requirements.txt` — pip-based installation
62-
- `environment.yml` — Conda-based installation (optional)
63-
64-
Step-by-step reproduction instructions and expected outputs are documented in `REPRODUCIBILITY.md`.
65-
66-
---
67-
68-
## Data sources
69-
70-
All analyses rely on **publicly available solar magnetogram data**, including NOAA and NSO/GONG products. No proprietary datasets are required.
71-
72-
---
73-
74-
## Citation and archiving
75-
76-
Formal citation metadata and archival information are provided in:
77-
78-
- `CITATION.cff`
79-
- `zenodo.json`
80-
81-
A versioned Zenodo DOI is minted upon release to ensure long-term traceability.
82-
83-
---
84-
85-
## License
86-
87-
See `LICENSE`.
88-
89-
---
90-
91-
## Contact
92-
93-
Antonios Valamontes
94-
Kapodistrian Academy of Science
95-
Email: avalamontes@Kapodistrian.edu.gr
51+
- Python 3.10+
52+
- Jupyter Notebook or JupyterLa

0 commit comments

Comments
 (0)