Organize the project by domain and name analyses by their rule
Energy code moves to src/energy/ and its docs to docs/energy/; shared code (CSV loading, venv switch, browser, zoom script) goes to src/common/, and the AIMsight originals to docs/aimsight/. Analyses are no longer numbered: two Energy scripts remain, daily.py (delivered state and trend) and all_analyses.py (comparison of the four). Calculations and pages unchanged (D-026). Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
This commit is contained in:
1 parent
77c8f24d2f
commit
8a32f4d418
44 files changed
+1757
-771
No files matched your search
@@ -1,12 +1,12 @@
|
||||
---
|
||||
paths:
|
||||
- "src/**"
|
||||
- "docs/analyses/**"
|
||||
- "docs/*/analyses/**"
|
||||
---
|
||||
|
||||
# Travailler sur une analyse
|
||||
|
||||
- **Avant de modifier** une analyse, lire sa fiche `docs/analyses/analyse_NN.md`. En particulier :
|
||||
- **Avant de modifier** une analyse, lire sa fiche `docs/<domaine>/analyses/<règle>.md` (ex. `docs/energy/analyses/daily_battery_state.md`). En particulier :
|
||||
- le principe ;
|
||||
- les constantes et leurs sources ;
|
||||
- les limites connues ;
|
||||
@@ -14,16 +14,16 @@ paths:
|
||||
- **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 (exception : analyses 03 en phase C et 04, où `None` = pas de verdict ; l'UNKNOWN est dans `facts.state` ou `facts.trend`) ;
|
||||
- `anomaly = None` signifie UNKNOWN (exception : `DAILY_BATTERY_STATE` en phase C et `DAILY_BATTERY_TREND`, où `None` = pas de verdict ; l'UNKNOWN est dans `facts.state` ou `facts.trend`) ;
|
||||
- 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`).
|
||||
- **Code de calcul** (`src/<domaine>/`) : bibliothèque standard uniquement et aucun import de `src/common/`, car il doit tourner sur la station. Plotly ne sert qu'aux graphiques, sur le poste de dev (`.venv`). Le chargement des CSV est dans `common.stations`.
|
||||
- **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). Des analyses à comparer partagent une page, un panneau chacune (D-016) ;
|
||||
- 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).
|
||||
- en haut, l'analyse avec ses courbes superposées ; dessous, un graphique par série temporelle (D-011). Des analyses à comparer partagent une page, un panneau chacune (D-016) : pour Energy, `src/energy/all_analyses.py` ;
|
||||
- zoom horizontal seulement, avec l'ordonnée recalée sur la plage visible (`post_script=common.page.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).
|
||||
- si c'est un savoir métier nouveau, l'ajouter dans `docs/domaine/` (commun) ou `docs/<domaine>/domaine/`.
|
||||
- **Vérifier à la main** sur VERMONT (`data/`) : pour Energy, `python3 src/energy/all_analyses.py`, et `python3 src/energy/daily.py` si l'analyse est livrée. Pas de tests automatisés en phase prototype (D-008).
|
||||
- **Nouvelle analyse** : utiliser le skill `nouvelle-analyse`.
|
||||
@@ -1,55 +1,52 @@
|
||||
---
|
||||
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.
|
||||
description: Créer une nouvelle analyse dans le projet de diagnostic AIMsight — règle, fiche, code dans son domaine, panneau de comparaison, 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/`.
|
||||
- **Domaine** : Energy (`src/energy/`, `docs/energy/`) ou un nouveau domaine, qui reçoit alors son propre `src/<domaine>/` et `docs/<domaine>/` (D-026). Le demander à l'utilisateur en cas de doute.
|
||||
- **Nom de la règle** : en anglais, en majuscules, **en mots complets sans abréviation** (ex. `MOVING_AVERAGE_7_DAYS_DROP`, D-017). Les analyses ne sont pas numérotées : le nom de la règle les désigne (D-026).
|
||||
- Lire, sans tout charger :
|
||||
- les « Pistes » et les « Limites connues » des fiches existantes. La nouvelle analyse en couvre souvent une ;
|
||||
- les « Pistes » et les « Limites connues » des fiches du domaine (`docs/<domaine>/analyses/`). 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).
|
||||
- la note de `docs/domaine/` ou de `docs/<domaine>/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**, pas dans `docs/superpowers/specs/` (D-010).
|
||||
|
||||
## 2. Écrire la fiche
|
||||
|
||||
- Copier `docs/analyses/_modele.md` vers `docs/analyses/analyse_NN.md` et remplir :
|
||||
- Copier `modele-fiche.md` (à côté de ce fichier) vers `docs/<domaine>/analyses/<règle en minuscules>.md` (ex. `daily_battery_state.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 ».
|
||||
- Nom de la règle : en anglais, majuscules, **mots complets sans abréviation** (ex. `MOVING_AVERAGE_7_DAYS_DROP`, D-017).
|
||||
|
||||
## 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.
|
||||
- Il utilise uniquement la bibliothèque standard, sans importer `src/common/` : il doit pouvoir s'embarquer seul.
|
||||
- `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.
|
||||
- Le module va dans `src/<domaine>/`. Les séries arrivent par `common.stations.load_stations`. Extraire du code partagé seulement quand une deuxième analyse en a vraiment besoin.
|
||||
- **Pas de point d'entrée par analyse** : ajouter le panneau de l'analyse à la page de comparaison du domaine (pour Energy, `figure()` et `main()` de `src/energy/all_analyses.py`). Si l'analyse devient livrée, elle rejoint aussi la page livrée (pour Energy, `src/energy/daily.py`).
|
||||
- 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=common.page.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`).
|
||||
- Lancer la page de comparaison du domaine sur VERMONT (pour Energy, `python3 src/energy/all_analyses.py`).
|
||||
- Comparer les résultats au diagnostic expert (`docs/energy/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 » ;
|
||||
- ajouter une ligne au tableau des analyses du domaine ;
|
||||
- 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/`.
|
||||
- `docs/decisions.md` : une entrée **seulement** si une décision de niveau projet a été prise (nouveau principe, changement de cap, nouveau domaine). Les choix propres à l'analyse restent dans sa fiche.
|
||||
- Un savoir métier découvert en chemin va dans `docs/domaine/` (commun) ou `docs/<domaine>/domaine/`.
|
||||
@@ -0,0 +1,48 @@
|
||||
# `NOM_DE_LA_REGLE` : titre court
|
||||
|
||||
- **Statut** : idée | en conception | prototype en place | livrée | comparaison seulement | abandonnée (date).
|
||||
- **Script** : la page qui montre l'analyse. Pour Energy : son panneau dans `python3 src/energy/all_analyses.py [CSV ou dossiers]` (défaut : `data/`), et dans `python3 src/energy/daily.py` si elle est livrée. La page est écrite dans `out/` et ouverte dans le navigateur.
|
||||
- **Code** : les modules utilisés, dans `src/<domaine>/` ; le calcul est en bibliothèque standard uniquement.
|
||||
|
||||
## Question posée
|
||||
|
||||
La question que cette analyse pose aux données, en une phrase. Préciser le lien avec la définition de l'anomalie (D-004) et ce que l'analyse ajoute aux analyses existantes.
|
||||
|
||||
## Principe
|
||||
|
||||
L'idée en 2 ou 3 phrases, puis le calcul exact, étape par étape, pour chaque horodatage t. Le calcul doit être **causal** et respecter le contrat commun (`run(series) -> {analysis, rule, points: [{t, value, anomaly, facts}]}`). Préciser ce que contiennent `value` (unité physique) et `facts`, et quand le point vaut UNKNOWN.
|
||||
|
||||
## Constantes et sources
|
||||
|
||||
| Constante | Valeur | Source |
|
||||
|---|---|---|
|
||||
| `…` | … | doc AIMsight, manuel, code embarqué, donnée observée (avec date et station), ou choix de conception assumé |
|
||||
|
||||
## Graphique
|
||||
|
||||
- **En haut** : l'analyse, avec ses courbes superposées.
|
||||
- **Dessous** : un graphique par série temporelle.
|
||||
|
||||
Préciser ce qui est affiché en plus : seuils, bandes, contenu du survol.
|
||||
|
||||
## Résultats sur VERMONT (jeu de travail)
|
||||
|
||||
Dates et valeurs observées, comparées au diagnostic expert (`docs/energy/domaine/cas-annotes-par-l-expert.md`).
|
||||
|
||||
## Options écartées
|
||||
|
||||
| Option | Pourquoi écartée |
|
||||
|---|---|
|
||||
| … | … |
|
||||
|
||||
## Limites connues
|
||||
|
||||
1. …
|
||||
|
||||
## Pistes
|
||||
|
||||
Ce qu'une autre analyse pourrait couvrir de ces limites.
|
||||
|
||||
## Historique
|
||||
|
||||
- **AAAA-MM-JJ** : création. Puis une ligne par modification notable, avec renvoi aux décisions `D-0XX` concernées.
|
||||
Reference in new issue
Block a user