CLAUDE.md: an improvement touches scripts/ and GUIDE.md only; self-test path from the caller
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
This commit is contained in:
1 parent
568794e1ea
commit
5ddf73ba8a
1 file changed
+2
-1
@@ -2,7 +2,7 @@
|
|||||||
|
|
||||||
tools: the reading harness of the AIMsight agents (`README.md`), and nothing else. The user guide is `GUIDE.md`; a new tool or a new option goes into it in the same change. `DATA.md` (what the data are) is maintained by hand by the user; `GUIDE.md` is the upgrader's (`agents` repository, run by Optimizer's `optimize` skill).
|
tools: the reading harness of the AIMsight agents (`README.md`), and nothing else. The user guide is `GUIDE.md`; a new tool or a new option goes into it in the same change. `DATA.md` (what the data are) is maintained by hand by the user; `GUIDE.md` is the upgrader's (`agents` repository, run by Optimizer's `optimize` skill).
|
||||||
|
|
||||||
- **Checking a change**: rerun the touched tool from a calling repository (Diagnostic-App: `python3 tools/scripts/<tool>.py data/<STATION> --start … --end …`), and the commands of the guide that use it; `python3 scripts/quality.py --self-test`.
|
- **Checking a change**: rerun the touched tool from a calling repository (Diagnostic-App: `python3 tools/scripts/<tool>.py data/<STATION> --start … --end …`), and the commands of the guide that use it; `python3 tools/scripts/quality.py --self-test` (from the calling repository).
|
||||||
|
|
||||||
Rules:
|
Rules:
|
||||||
- A tool returns values: no threshold, no category, no "anomaly", no "normal"; the analyst judges.
|
- A tool returns values: no threshold, no category, no "anomaly", no "normal"; the analyst judges.
|
||||||
@@ -11,6 +11,7 @@ Rules:
|
|||||||
- Standard library; matplotlib, through the caller's `.venv/bin/python`, for the figures only.
|
- Standard library; matplotlib, through the caller's `.venv/bin/python`, for the figures only.
|
||||||
- Never a value from `metrics/` that is an identifier (`SIM_CCID`, `ip*`); read-only on `data/`; never read `.env`.
|
- Never a value from `metrics/` that is an identifier (`SIM_CCID`, `ip*`); read-only on `data/`; never read `.env`.
|
||||||
- Break nothing: existing options and outputs stay, the analyses' reports cite commands that must keep working.
|
- Break nothing: existing options and outputs stay, the analyses' reports cite commands that must keep working.
|
||||||
|
- A change to improve the tools touches `scripts/` and `GUIDE.md` only; `README.md`, `CLAUDE.md` and `DATA.md` (the user's) are not part of it.
|
||||||
- Remove nothing: no tool, no option, no output, no sentence of the guide; a tool that did not help on one range may help on another, and a single analysis is not enough to clean the list. Optimise or add.
|
- Remove nothing: no tool, no option, no output, no sentence of the guide; a tool that did not help on one range may help on another, and a single analysis is not enough to clean the list. Optimise or add.
|
||||||
- The simplest first: a sentence of the guide or a better default; otherwise an option of an existing tool; a new tool as a last resort. A new script has a docstring at the top, like the others, and enters the table of `GUIDE.md` in the same change.
|
- The simplest first: a sentence of the guide or a better default; otherwise an option of an existing tool; a new tool as a last resort. A new script has a docstring at the top, like the others, and enters the table of `GUIDE.md` in the same change.
|
||||||
- `scripts/data.py` is the common reader of the app and the tools: touch it only to fix a reading error. The app passes these measurements to the detectors (the events of the Data page), which otherwise read with `detectors/scripts/data.py` (benchmark, Optimizer): a reading fix here is carried over there, otherwise the page and the benchmark diverge silently. A change to `data.py` is said at the top of the change's report; the same fix in `detectors/scripts/data.py` is left to the user, named in that report.
|
- `scripts/data.py` is the common reader of the app and the tools: touch it only to fix a reading error. The app passes these measurements to the detectors (the events of the Data page), which otherwise read with `detectors/scripts/data.py` (benchmark, Optimizer): a reading fix here is carried over there, otherwise the page and the benchmark diverge silently. A change to `data.py` is said at the top of the change's report; the same fix in `detectors/scripts/data.py` is left to the user, named in that report.
|
||||||
|
|||||||
Reference in new issue
Block a user