Skip to content

Commit 8bb0ed4

Browse files
authored
Merge pull request #72 from PyAutoLabs/feature/pyautoscientist-3b-spawn
PyAutoScientist 3b-1: RTD template-family walkthrough
2 parents da3f6ef + 8f75735 commit 8bb0ed4

2 files changed

Lines changed: 43 additions & 14 deletions

File tree

docs/adoption/guide.md

Lines changed: 36 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -23,31 +23,54 @@ work, this system is not for you (and that's fine):
2323

2424
## The walkthrough
2525

26+
Every "create" step below is a GitHub **Use this template** click — the
27+
template repos are generated from the live organism and satisfy every
28+
contract on day one.
29+
2630
1. **Fork Brain, Heart, Hands** (keep the repo names — they are framework
2731
identity).
28-
2. **Create your Mind** with the documented shape
29-
([PyAutoMind/REFERENCE.md](https://github.com/PyAutoLabs/PyAutoMind/blob/main/REFERENCE.md)):
30-
the registry files, the work-type prompt folders, a copy of `scripts/`,
31-
and — the load-bearing part — **your own `repos.yaml` body map** listing
32-
your libraries, workspaces and their categories per the
33-
{doc}`category contract <../satellites>`.
34-
3. **Replace the config surfaces** in your forks with rows for your repos —
32+
2. **Create your Mind from
33+
[PyAutoMind-template](https://github.com/PyAutoLabs/PyAutoMind-template)**:
34+
the registry files, work-type prompt folders and generic `scripts/` come
35+
ready, and its `repos.yaml` body map is pre-filled with the template
36+
satellite family below. The schemas it follows are documented in
37+
[REFERENCE.md](https://github.com/PyAutoLabs/PyAutoMind/blob/main/REFERENCE.md).
38+
3. **Create your science repos from the PyAutoProject family**
39+
[PyAutoProject](https://github.com/PyAutoLabs/PyAutoProject) (the
40+
library: a working 1D-Gaussian model + `Analysis` + packaged prior
41+
config on the PyAutoFit engine),
42+
[autoproject_workspace](https://github.com/PyAutoLabs/autoproject_workspace)
43+
(end-to-end scripts that build to notebooks; `start_here.py` teaches the
44+
convention), and
45+
[autoproject_workspace_test](https://github.com/PyAutoLabs/autoproject_workspace_test)
46+
(smoke/regression scripts). Rename `autoproject` to your science and
47+
replace the Gaussian with your model — the {doc}`category contract
48+
<../satellites>` is what each repo must keep honouring.
49+
4. **Replace the config surfaces** in your forks with rows for your repos —
3550
the complete inventory with file paths is {doc}`config_surfaces`. The
3651
big three: Heart's `config/repos.yaml` (what to poll and gate), the
3752
Hands' `run_workspace` table in `pre_build.sh` (what the pipeline runs),
3853
and the Brain's constant tables (sizing sets, routing keywords, the
3954
release library tuple).
40-
4. **Regenerate and check.** `python3 <YourMind>/scripts/repos_sync.py
55+
5. **Regenerate and check.** `python3 <YourMind>/scripts/repos_sync.py
4156
--write` stamps the generated doc blocks from your body map; `--check`
4257
verifies every mirror agrees — including the tenant firewall, which
4358
fails if an upstream instance fact survives anywhere outside the
4459
declared surfaces you just replaced.
45-
5. **Install the command surface**: `bash <YourBrain>/bin/install.sh`
60+
6. **Install the command surface**: `bash <YourBrain>/bin/install.sh`
4661
symlinks every organ's skills into `~/.claude`.
47-
6. **Create your Memory when you need it** — the shape is documented in
48-
{doc}`the Memory page <../organs/memory>`; the organism runs fine
49-
without one until your domain knowledge accumulates.
50-
7. **Go.** Write your first prompt in your Mind and run `/start_dev` on it.
62+
7. **Create your Memory from
63+
[PyAutoMemory-template](https://github.com/PyAutoLabs/PyAutoMemory-template)
64+
when you need it** — the wiki schema, bibliography tooling and citation
65+
validation come wired, with one empty `example_wiki/` to copy per
66+
domain; the organism runs fine without it until your knowledge
67+
accumulates. Your assistant repo comes later still — grown by the clone
68+
agent once your project matures, never hand-built.
69+
8. **Go.** Write your first prompt in your Mind and run `/start_dev` on it.
70+
71+
The Mind and Memory templates are **generated views** of the live organism
72+
(stamped by `spawn`, drift-checked in CI) — they track the live structure
73+
without ever containing its content.
5174

5275
## Staying current
5376

docs/satellites.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,4 +32,10 @@ Two properties make the contract workable:
3232
contract can't silently rot.
3333

3434
An adopter's minimal viable body: one `library` + one `workspace`. Every
35-
other category is opt-in as your project grows into it.
35+
other category is opt-in as your project grows into it. The contract has a
36+
working embodiment you can copy — the **PyAutoProject template family**
37+
([PyAutoProject](https://github.com/PyAutoLabs/PyAutoProject) +
38+
[autoproject_workspace](https://github.com/PyAutoLabs/autoproject_workspace) +
39+
[autoproject_workspace_test](https://github.com/PyAutoLabs/autoproject_workspace_test)),
40+
a complete 1D-Gaussian project satisfying every expectation in the table;
41+
the {doc}`adoption guide <adoption/guide>` walks through it.

0 commit comments

Comments
 (0)