Add SEM_Overview.md and SEM_Mathematical_Apparatus.md under docs/ and link from README

2026-05-09 19:24:43 +01:00
parent 80f99d1d15
commit fa87dbb473
3 changed files with 550 additions and 0 deletions
@@ -147,6 +147,15 @@ internally cast to contiguous `float64`.  Outputs are numpy arrays.

 See the wrapper docstrings for exact semantics of each function.

+## Documentation
+
+- [`docs/SEM_Overview.md`](./docs/SEM_Overview.md) — non-internal
+  introduction to SEM (Similarity Energy Model), what it does, and
+  how the `sem_cython12` library fits in.
+- [`docs/SEM_Mathematical_Apparatus.md`](./docs/SEM_Mathematical_Apparatus.md)
+  — capabilities-level description of the operators and engines
+  exposed by the library.
+
 ## Demos

 Three runnable demos live in [`demos/`](./demos/):