Document the project: decisions log, analysis sheet, domain notes
- CLAUDE.md becomes a short map: status and next step, analyses index, documentation map, working rules. - docs/decisions.md: ADR-style project decision log (D-001..D-014). - docs/analyses/: living sheet per analysis (analyse_01) and template. - docs/domaine/: domain knowledge, one note per question. - .claude/rules/analyses.md: path-scoped rule loaded on src/ and docs/analyses/; .claude/skills/nouvelle-analyse: new-analysis workflow. - README.md: human entry point. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
This commit is contained in:
1 parent
0b950199b8
commit
8992bda17e
12 files changed
+588
-49
No files matched your search
@@ -0,0 +1,29 @@
|
||||
---
|
||||
paths:
|
||||
- "src/**"
|
||||
- "docs/analyses/**"
|
||||
---
|
||||
|
||||
# Travailler sur une analyse
|
||||
|
||||
- **Avant de modifier** une analyse, lire sa fiche `docs/analyses/analyse_NN.md`. En particulier :
|
||||
- le principe ;
|
||||
- les constantes et leurs sources ;
|
||||
- les limites connues ;
|
||||
- les **options écartées** (ne pas les reproposer sans raison nouvelle).
|
||||
- **Contrat commun** :
|
||||
- `run(series) -> {analysis, rule, points: [{t, value, anomaly, facts}]}` ;
|
||||
- calcul **causal** : le point t n'utilise que les données ≤ t ;
|
||||
- `anomaly = None` signifie UNKNOWN ;
|
||||
- une analyse seule conclut au plus `consistent with`.
|
||||
- **Code de calcul** : bibliothèque standard uniquement, car il doit tourner sur la station. Plotly ne sert qu'aux graphiques, sur le poste de dev (`.venv`).
|
||||
- **Constantes** : chacune a sa source, en commentaire dans le code et dans le tableau de la fiche. Aucun seuil sans source.
|
||||
- **Graphique** :
|
||||
- en haut, l'analyse avec ses courbes superposées ; dessous, un graphique par série temporelle (D-011) ;
|
||||
- zoom horizontal seulement, avec l'ordonnée recalée sur la plage visible (`post_script=energy_plot.AUTOSCALE_Y_JS`, ordonnées en `fixedrange`, D-013).
|
||||
- **Après modification** :
|
||||
- mettre à jour la fiche dans le même changement (résultats, limites, historique) ;
|
||||
- si c'est une décision projet, ajouter une entrée dans `docs/decisions.md` ;
|
||||
- si c'est un savoir métier nouveau, l'ajouter dans `docs/domaine/`.
|
||||
- **Vérifier à la main** avec `python3 src/analyse_NN.py` sur VERMONT (`data/`). Pas de tests automatisés en phase prototype (D-008).
|
||||
- **Nouvelle analyse** : utiliser le skill `nouvelle-analyse`.
|
||||
@@ -0,0 +1,54 @@
|
||||
---
|
||||
name: nouvelle-analyse
|
||||
description: Créer une nouvelle analyse numérotée (analyse_NN) dans le projet de diagnostic AIMsight — script, fiche, index, journal. À utiliser dès que l'utilisateur veut ajouter, concevoir ou prototyper une nouvelle analyse des séries temporelles d'une station.
|
||||
---
|
||||
|
||||
# Créer une nouvelle analyse
|
||||
|
||||
## 1. Situer l'analyse
|
||||
|
||||
- Prendre le numéro suivant `NN` : voir le tableau « Analyses » de `CLAUDE.md` et `docs/analyses/`.
|
||||
- Lire, sans tout charger :
|
||||
- les « Pistes » et les « Limites connues » des fiches existantes. La nouvelle analyse en couvre souvent une ;
|
||||
- `docs/decisions.md`, en particulier les options écartées ;
|
||||
- la note de `docs/domaine/` qui concerne la question posée.
|
||||
- Si la conception demande des choix, en discuter avec l'utilisateur. Avec superpowers (brainstorming), **la spec s'écrit directement dans la fiche** `docs/analyses/analyse_NN.md`, pas dans `docs/superpowers/specs/` (D-010).
|
||||
|
||||
## 2. Écrire la fiche
|
||||
|
||||
- Copier `docs/analyses/_modele.md` vers `docs/analyses/analyse_NN.md` et remplir :
|
||||
- la question posée ;
|
||||
- le principe et le calcul exact ;
|
||||
- les constantes **avec leur source** ;
|
||||
- les options écartées.
|
||||
- Statut : « en conception ».
|
||||
|
||||
## 3. Écrire le code
|
||||
|
||||
- Le calcul respecte le contrat commun : `run(series) -> {analysis, rule, points: [{t, value, anomaly, facts}]}`.
|
||||
- Il est causal.
|
||||
- Il utilise uniquement la bibliothèque standard.
|
||||
- `value` est exprimé dans une unité physique, sans pseudo-probabilité.
|
||||
- Une analyse seule conclut au plus `consistent with`.
|
||||
- Réutiliser `src/energy_check.py` (`load_stations`, grille horaire, traitement des `NaN`) plutôt que de le recopier. Extraire du code partagé seulement quand une deuxième analyse en a vraiment besoin.
|
||||
- Point d'entrée `src/analyse_NN.py`, sur le modèle de `src/analyse_01.py` :
|
||||
- il s'exécute sur `data/` par défaut ;
|
||||
- il bascule sur `.venv` si plotly manque ;
|
||||
- il écrit le graphique dans `out/` et l'ouvre dans le navigateur.
|
||||
- Graphique (D-011) : en haut, l'analyse avec ses courbes superposées ; dessous, un graphique par série temporelle. Écrire le HTML avec `post_script=energy_plot.AUTOSCALE_Y_JS` et des ordonnées en `fixedrange`, pour que l'ordonnée se recale à chaque zoom.
|
||||
- Pas de tests automatisés en phase prototype (D-008).
|
||||
|
||||
## 4. Vérifier
|
||||
|
||||
- Lancer `python3 src/analyse_NN.py` sur VERMONT.
|
||||
- Comparer les résultats au diagnostic expert (`docs/domaine/cas-annotes-par-l-expert.md`).
|
||||
- Reporter les dates et valeurs observées dans la section « Résultats » de la fiche.
|
||||
|
||||
## 5. Documenter
|
||||
|
||||
- Fiche : statut « prototype en place », résultats, limites, historique.
|
||||
- `CLAUDE.md` :
|
||||
- ajouter une ligne au tableau « Analyses » et la commande dans « Commandes » ;
|
||||
- mettre à jour « État et prochaine étape ».
|
||||
- `docs/decisions.md` : une entrée **seulement** si une décision de niveau projet a été prise (nouveau principe, changement de cap). Les choix propres à l'analyse restent dans sa fiche.
|
||||
- Un savoir métier découvert en chemin va dans `docs/domaine/`.
|
||||
Reference in new issue
Block a user