This is the repository-wide documentation map. docs/ connects supported
interfaces to their execution contracts; theory owns
mathematical definitions, hypotheses and proofs. Tutorials show how to call an
owner, contracts specify admission and output, and theory states what follows
under which assumptions. None creates a second research queue.
Start with the root README for installation and first use. For a scientific question, use the theory index's reading routes and its map from definitions to engine modules, tests and SDK entry points.
Choose the execution contract before following an example:
- Operator words: CLI and SDK and event contracts cover registered operators, grammar and live admission. Word counts are not elapsed structural time.
- Native relational evolution: the joint execution guide and contract describe the argument-based law, held capacity and phase-domain checks.
- Normalized-sine comparison: the
comparison guide
and contract
identify a separate smooth law. Its observation, certificate and forecast
APIs do not silently select a new law for
Network.step_relational. Reports for alternative reciprocal mobilities retain their own complete laws; shared storage does not transfer every theorem between them.
For meanings and proofs, use the resonance distinctions and scale owner. A gain peak, prepared periodic pulse, recurrent family and protected geometry are different results. For formation, the guide separates validated native transit and its robustness audit from sine preparation barriers. The sine dynamics reading map connects positive prepared acquisition, capture, controlled reduction and budget/symmetry controls under that same smooth law. For implementation reuse, the regional guide's task map separates actual contact feedback and retained hidden memory from exact collective families and finite maintenance bounds. A tangent reduction, prepared moving family and measured state have different source obligations; common storage or constant means alone does not join their theorems. These tools answer different questions: source, complete law, uncertainty and admission determine what each report establishes. The execution plan selects the research task; an available guide does not create an active campaign.
| Maintained owner | Use it for | Boundary |
|---|---|---|
| CLI and SDK | Network creation, operator studies, diagnostics, JSON and command routes | Word counts are not physical time; reports are not checkpoints |
| Regional and relational SDK | Native joint evolution, separate sine assessments, regional observations and scoped certificates | Preparations, references and uncertainty are inputs; captured states and declared exact families have different admission |
| Native relational execution and observations | Argument-based field and finite-step execution, native tangents, prepared patterns and hypothetical support/state events. | Each result retains its declared complete law and evidence scope |
| Native relational capture, memory and continuous proofs | Native capture and exclusions, cycle/contact memory, transit, reflected proofs, regularity and retained robustness evidence. | Each result retains its declared complete law and evidence scope |
| Shared observations, information and finite-sample bounds | Regional and source-relative observations, exact linear and phase-moment information, finite-sample evidence and shared circular geometry. | Each result retains its declared complete law and evidence scope |
| Normalized-sine comparison, inference and forecasts | Shared sine-law report admission, captured comparison, retained mediation, sampling, hidden state/capacity inference and prior-only forecasting. | Each result retains its declared complete law and evidence scope |
| Sine response, constitutive comparisons and hidden memory | Declared input/output resonance, bridge-law and clock discrimination, return-path geometry, causal hidden memory, autonomous pulses and recurrence distinctions. | Each result retains its declared complete law and evidence scope |
| Sine pattern geometry, formation and recovery | Relative patterns and origins, composition, equilibrium and symmetry, prepared formation, recovery/capture, controlled slow references and budget exclusions. | Each result retains its declared complete law and evidence scope |
| Conservative sine saddle preparations and certificates | Signed-involution preparation, the C5/private-leaf saddle, directed passage, same-orbit retention, sensitivity, retained-metric forecasts and constitutive controls. | Each result retains its declared complete law and evidence scope |
| Conservative sine regional and collective dynamics | Regional storage and currents, conservative winding acquisition and retention, compatible collective families, actual contact feedback and forecast-derived organization. | Each result retains its declared complete law and evidence scope |
| Retained sine pair state, identification and pulses | Sufficient unordered/mixed pair state and cancellation inversion, capacities and support symmetry, pairing observations and windows, emission/transfer and doubled-C5 pulse response. | Each result retains its declared complete law and evidence scope |
| Observational interfaces | Feature graphs, multichannel signals, comparisons and reserved forecasts | Engineering adapters do not independently identify canonical physical variables |
| Optional Torch backend | Backend selection, device checks and execution limits | Requested backend, effective device and measured acceleration are different claims |
| Maintained owner | Responsibility | Primary evidence |
|---|---|---|
| API contracts | Shared admission, nodal solvers and generated operator metadata | Actual execution owners and operator registry |
| Relational dynamics | Native field/step, separate sine-law reports, support budgets, uncertainty and forecast admission | Exact continuous theorems, finite steps, validated enclosures and retained records have distinct guarantees |
| Native relational execution and observations | Argument-based field and finite-step execution, native tangents, prepared patterns and hypothetical support/state events. | Each result retains its declared complete law and evidence scope |
| Native relational capture, memory and continuous proofs | Native capture and exclusions, cycle/contact memory, transit, reflected proofs, regularity and retained robustness evidence. | Each result retains its declared complete law and evidence scope |
| Shared observations, information and finite-sample bounds | Regional and source-relative observations, exact linear and phase-moment information, finite-sample evidence and shared circular geometry. | Each result retains its declared complete law and evidence scope |
| Normalized-sine comparison, inference and forecasts | Shared sine-law report admission, captured comparison, retained mediation, sampling, hidden state/capacity inference and prior-only forecasting. | Each result retains its declared complete law and evidence scope |
| Sine response, constitutive comparisons and hidden memory | Declared input/output resonance, bridge-law and clock discrimination, return-path geometry, causal hidden memory, autonomous pulses and recurrence distinctions. | Each result retains its declared complete law and evidence scope |
| Sine pattern geometry, formation and recovery | Relative patterns and origins, composition, equilibrium and symmetry, prepared formation, recovery/capture, controlled slow references and budget exclusions. | Each result retains its declared complete law and evidence scope |
| Conservative sine saddle preparations and certificates | Signed-involution preparation, the C5/private-leaf saddle, directed passage, same-orbit retention, sensitivity, retained-metric forecasts and constitutive controls. | Each result retains its declared complete law and evidence scope |
| Conservative sine regional and collective dynamics | Regional storage and currents, conservative winding acquisition and retention, compatible collective families, actual contact feedback and forecast-derived organization. | Each result retains its declared complete law and evidence scope |
| Retained sine pair state, identification and pulses | Sufficient unordered/mixed pair state and cancellation inversion, capacities and support symmetry, pairing observations and windows, emission/transfer and doubled-C5 pulse response. | Each result retains its declared complete law and evidence scope |
| Operator events | Schedules, jumps, atomic stages, REMESH and finite executor evidence | Shared event and history owners; no unrestricted stability guarantee |
| Structural fields | Tetrad definitions, units, availability and estimator provenance | Shared field readers; the tetrad is not a complete state basis |
| Responsibility | Primary owner |
|---|---|
| Contributor and agent instructions | AGENTS, mirrored verbatim at .github/agents/my-agent.md |
| Package boundaries and execution paths | Architecture |
| Test selection and development | Testing, Contributing |
| CI, publication and reporting | Workflows, Security |
| Documentation commands and staging | Scripts |
| Definitions, derivations and scientific scope | Theory catalog; glossary for classified concept cards |
| Grammar policies and verification | Unified grammar; rules and evidence share that owner |
| Research rationale and branch roles | Portfolio classifies branches; strategy explains their scientific purpose |
| Current state, resumption and active gates | Execution checkpoint and its single active gate, not additional overview task lists |
| Maintained runnable entry points | Examples, benchmarks, optional applications |
| Historical results and supersession | Archive, including reported interface observations |
| Past publication statements | Changelog; historical claims are not current guarantees |
Change the implementation or definition and its owner together. Summaries link to that owner; they do not copy derivations, configuration tables or delivery histories. Keep usage examples separate from the full admission contract. The agent mirror is the only intentionally exact prose duplicate.
Keep each maintained theory or documentation owner at most 4,000 physical lines.
This editorial limit is checked by scripts/check_documentation.py; split by
model and responsibility before extending a large owner. Put shared admission
in its contract, proofs in their theory chapter, and examples in the matching
guide. Update canonical links and retain existing section aliases when moving
published material. Archived records and frozen evidence retain their own
provenance and are outside this size guard.
The catalog above owns the technical website menu; the theory catalog owns its
own menu. python scripts/check_documentation.py --write-generated refreshes
both menus, the registry-derived operator table and the glossary index. The
ordinary gate checks catalog coverage and generated agreement. Link/fragment
checking and a strict site build also belong to the
documentation checks. Generated consistency does not
validate a theorem or a physical identification.
The glossary's declaration classes and dependency/evidence checks are specified
by its own template and scripts/check_glossary.py. Do not redefine concept
admission in another index or infer scientific proof from a valid link.
docs/assets/ holds website support and referenced frozen research evidence,
including source archives and numerical reports. Preserve those paths and bytes;
new runs belong in artifacts/, not over the published record. Retaining an
old result does not promote it into the current execution contract.
Use retained-evidence checks
and the instrument lifecycle
to distinguish read-only audits from a separately declared new evaluation.
artifacts/, ignored output/, outputs/ and results/ retain local receipts
and earlier source contexts. They are not current guides or another task queue.
build/docs-source/ and site/ are generated; edit their maintained inputs.
Retire a document only after moving useful material to its owner and repairing maintained references. Preserve source-bound observations and mark their scope and replacement. Archive records explain supersession; older manifests retain their original recovery paths and hashes. Superseded plans and unused campaign drivers need not remain as duplicate archive copies once their unchanged committed content has verified Git recovery. Keep a concise reason and replacement in a recovery record. An old date is not a retirement criterion: useful conditional results and negative controls remain with their maintained owners. Uncommitted material and unique frozen evidence require preservation before any removal.