Skip to content

Commit fc9c920

Browse files
Copilotfermga
andcommitted
Add executive summary, tooling docs, fix JSON schemas, simplify main README
Co-authored-by: fermga <203334638+fermga@users.noreply.github.com>
1 parent cc0a1f8 commit fc9c920

File tree

7 files changed

+1217
-207
lines changed

7 files changed

+1217
-207
lines changed

README.md

Lines changed: 24 additions & 107 deletions
Original file line numberDiff line numberDiff line change
@@ -137,113 +137,30 @@ At the heart of TNFR is one elegant equation:
137137

138138
## 📚 Documentation
139139

140-
### 🎯 Single Source of Truth for Mathematics
141-
142-
**[Mathematical Foundations of TNFR](docs/source/theory/mathematical_foundations.md)**
143-
144-
This is THE ONLY place where TNFR mathematics is formally defined:
145-
- Hilbert space H_NFR and Banach space B_EPI
146-
- Coherence operator Ĉ (spectral theory, proofs)
147-
- Frequency operator Ĵ and reorganization operator ΔNFR
148-
- Complete nodal equation derivation
149-
- **§3.1.1**: Implementation bridge (theory → code)
150-
151-
### 🎯 Classical Mechanics Emergence
152-
153-
**TNFR reveals how observable classical physics emerges from structural coherence dynamics**:
154-
155-
```
156-
TNFR Nodal Equation (∂EPI/∂t = νf · ΔNFR)
157-
158-
Low-dissonance limit (ε → 0)
159-
160-
Observable Classical Mechanics
161-
```
162-
163-
**Key Emergent Phenomena**:
164-
- **Mass**: `m = 1/νf` (inverse structural frequency) — mass is structural inertia
165-
- **Force**: `F = -∇U(q)` (coherence potential gradient) — force is stability flow
166-
- **Newton's Laws**: Natural consequences of the nodal equation at low dissonance
167-
- **Action Principle**: Coherence optimization over time
168-
- **Conservation Laws**: Network symmetries preserve structural quantities
169-
170-
**Documentation**:
171-
- **[📘 N-Body Classical Mechanics Guide](docs/TNFR_CLASSICAL_NBODY.md)****Complete formal reference** (variable mappings, conservation laws, validation protocols, code examples)
172-
- [Classical Mechanics from TNFR](docs/source/theory/07_emergence_classical_mechanics.md) — Complete derivation from nodal equation
173-
- [Euler-Lagrange Correspondence](docs/source/theory/08_classical_mechanics_euler_lagrange.md) — Variational formulation
174-
- [Numerical Validation](docs/source/theory/09_classical_mechanics_numerical_validation.md) — Computational verification
175-
176-
**Practical Examples**:
177-
- `examples/domain_applications/nbody_gravitational.py` — Two-body orbits, three-body systems
178-
- `examples/nbody_quantitative_validation.py` — Full validation suite (6 canonical experiments)
179-
- `tests/validation/test_nbody_validation.py` — Automated test suite
180-
181-
This demonstrates **classical mechanics as a natural expression of coherent structural dynamics** in the observable, deterministic regime.
182-
183-
### 📖 Quick References
184-
185-
- **[GLOSSARY](GLOSSARY.md)** - Operational definitions for code use
186-
- **[TNFR Concepts](docs/source/getting-started/TNFR_CONCEPTS.md)** - Paradigm introduction
187-
- **[API Overview](docs/source/api/overview.md)** - Package architecture
188-
- **[Operator Guide](docs/source/api/operators.md)** - Complete operator reference
189-
- **[NAV Guide](docs/source/operators/NAV_GUIDE.md)** - NAV (Transition) canonical sequences, anti-patterns, and troubleshooting
190-
- **[THOL Configuration Reference](docs/THOL_CONFIGURATION_REFERENCE.md)** - Comprehensive THOL parameter guide
191-
192-
### 🎨 Grammar System
193-
194-
TNFR uses a unified physics-based grammar to validate operator sequences.
195-
All constraints emerge inevitably from the nodal equation and TNFR invariants.
196-
197-
#### Four Canonical Constraints (U1-U4)
198-
199-
1. **U1: STRUCTURAL INITIATION & CLOSURE**
200-
- U1a: Start with generators when EPI=0
201-
- U1b: End with closure operators
202-
- Basis: ∂EPI/∂t undefined at EPI=0
203-
204-
2. **U2: CONVERGENCE & BOUNDEDNESS**
205-
- If destabilizers, then include stabilizers
206-
- Basis: ∫νf·ΔNFR dt must converge
207-
208-
3. **U3: RESONANT COUPLING**
209-
- If coupling/resonance, then verify phase
210-
- Basis: AGENTS.md Invariant #5
211-
212-
4. **U4: BIFURCATION DYNAMICS**
213-
- U4a: If triggers, then include handlers
214-
- U4b: If transformers, then recent destabilizer
215-
- Basis: Contract OZ + bifurcation theory
216-
217-
**For complete derivations:** See [UNIFIED_GRAMMAR_RULES.md](UNIFIED_GRAMMAR_RULES.md)
218-
219-
**For implementation:** See `src/tnfr/operators/grammar.py`
220-
221-
#### Quick Start
222-
223-
```python
224-
from tnfr.operators.grammar import validate_grammar
225-
from tnfr.operators.definitions import Emission, Coherence, Silence
226-
227-
sequence = [Emission(), Coherence(), Silence()]
228-
is_valid = validate_grammar(sequence, epi_initial=0.0)
229-
```
230-
231-
#### Migration from Old Grammar Systems
232-
233-
If you're using the old C1-C3 or RC1-RC4 systems:
234-
235-
- **Old:** `from tnfr.operators.grammar import validate_sequence`
236-
- **New:** `from tnfr.operators.grammar import validate_grammar`
237-
238-
See migration guide in [GRAMMAR_MIGRATION_GUIDE.md](GRAMMAR_MIGRATION_GUIDE.md)
239-
240-
### 🧪 Advanced Topics
241-
242-
- [ARCHITECTURE.md](ARCHITECTURE.md) - System design & invariants
243-
- [Backend System](docs/backends.md) - NumPy/JAX/Torch backends
244-
- [TESTING.md](TESTING.md) - Test strategy & validation
245-
- [SECURITY.md](SECURITY.md) - Security practices
246-
- [CONTRIBUTING.md](CONTRIBUTING.md) - Development workflow
140+
### Core Documentation
141+
142+
**Theory & Foundations**
143+
- 📘 **[Mathematical Foundations](docs/source/theory/mathematical_foundations.md)** - Formal TNFR mathematics
144+
- 📖 **[TNFR Concepts](docs/source/getting-started/TNFR_CONCEPTS.md)** - Paradigm introduction
145+
- 📋 **[GLOSSARY](GLOSSARY.md)** - Operational definitions
146+
- 🔬 **[Classical Mechanics Emergence](docs/TNFR_CLASSICAL_NBODY.md)** - How classical physics emerges from TNFR
147+
148+
**Grammar System**
149+
- 🎯 **[Grammar Documentation Hub](docs/grammar/README.md)** - Complete navigation guide
150+
- 📐 **[Unified Grammar Rules](UNIFIED_GRAMMAR_RULES.md)** - U1-U4 constraint derivations
151+
- 🚀 **[Grammar Quick Reference](docs/grammar/08-QUICK-REFERENCE.md)** - One-page cheat sheet
152+
- 📊 **[Executive Summary](docs/grammar/EXECUTIVE-SUMMARY.md)** - For managers and stakeholders
153+
154+
**Implementation & API**
155+
- ⚙️ **[API Overview](docs/source/api/overview.md)** - Package architecture
156+
- 🔧 **[Operator Guide](docs/source/api/operators.md)** - Complete operator reference
157+
- 🛠️ **[ARCHITECTURE](ARCHITECTURE.md)** - System design
158+
159+
**Development**
160+
- 🤝 **[CONTRIBUTING](CONTRIBUTING.md)** - Development workflow
161+
- 🧪 **[TESTING](TESTING.md)** - Test strategy
162+
- 🔒 **[SECURITY](SECURITY.md)** - Security practices
163+
- 🎓 **[AGENTS](AGENTS.md)** - Canonical invariants and guidance
247164

248165
---
249166

docs/grammar/08-QUICK-REFERENCE.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
**One-page cheat sheet for TNFR grammar validation**
44

5-
[💾 Download PDF](08-QUICK-REFERENCE.pdf)[📖 Full Docs](README.md)[🔬 Deep Dive](02-CANONICAL-CONSTRAINTS.md)
5+
[📖 Full Docs](README.md)[🔬 Deep Dive](02-CANONICAL-CONSTRAINTS.md)[📚 Glossary](GLOSSARY.md)
66

77
---
88

0 commit comments

Comments
 (0)