Skip to content

Commit 88650af

Browse files
Jammy2211claude
authored andcommitted
docs: add signpost llms.txt routing to docs/ecosystem
Thin front-door llms.txt at the repo root following the llms.txt convention (H1 + blockquote summary, then sections of one-line links). It only points — no source-tree catalogue, no AGENTS.md/docs duplication — routing an LLM by intent to the API, the docs, AGENTS.md, and its place in the ecosystem. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
1 parent 4108bd8 commit 88650af

1 file changed

Lines changed: 15 additions & 0 deletions

File tree

llms.txt

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# PyAutoArray
2+
3+
> PyAutoArray (package `autoarray`) is the foundational data-structure and numerical layer of the PyAuto ecosystem — masks, arrays, (y,x) grids, imaging/interferometer datasets, inversions/pixelizations, and the canonical home of the grid-decorator system and JAX `xp` internals that PyAutoGalaxy and PyAutoLens inherit. This file is a signpost: it points you to the right resource by intent — see where it is used, or work on the library itself.
4+
5+
## Where it's used
6+
7+
- PyAutoArray has no standalone workspace or tutorial series; it provides the data structures the science libraries build on. You meet it in practice through [PyAutoGalaxy](https://github.com/PyAutoLabs/PyAutoGalaxy) and [PyAutoLens](https://github.com/PyAutoLabs/PyAutoLens) (and their workspaces), which consume its arrays, grids and inversions directly.
8+
9+
## Work on it (contributors / coding agents)
10+
11+
- [AGENTS.md](./AGENTS.md): build, tests, architecture, and the JAX / grid-decorator conventions (deep reference in `docs/agents/jax_and_decorators.md`).
12+
13+
## Ecosystem
14+
15+
- Built on PyAutoConf (config); used by PyAutoGalaxy and PyAutoLens, which inherit its grid decorators and JAX `xp` backend.

0 commit comments

Comments
 (0)