davideandClaude Sonnet 5.5
f28bddc5a2
- docs/SPEC.md sostituito da un file per argomento (indice in docs/README.md) - assunzioni A1-A24 con dove nel codice e cosa succede se false - formule in LaTeX corrette (nessuno spazio prima del dollaro di chiusura), simboli e chiavi in tabella - diagrammi Mermaid per il flusso degli algoritmi e le dipendenze dei moduli - figura dei domini sul seed 1 (docs/img/domini_esempio.png) - README ridotto a indice con avvio rapido; CLAUDE.md e docstring allineati Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
1.7 KiB
1.7 KiB
Documentazione di fitseg
Un file per argomento. Per un primo giro leggi panoramica, poi uso; per capire perché i numeri sono quelli che sono, assunzioni e algoritmi.
| File | Contenuto | Quando leggerlo |
|---|---|---|
| panoramica.md | cosa fa il programma, il segnale, glossario, un esempio completo | per iniziare |
| uso.md | installazione, dati di ingresso, comandi, correggere i domini a mano, codici di uscita | per usarlo |
| assunzioni.md | ogni assunzione (A1–A24): perché, dove nel codice, cosa succede se è falsa; origine dei dati di prova | per fidarsi (o no) dei risultati |
| algoritmi.md | rilevamento dei gradini, domini, fit, incertezze, metriche, scelta del modello, con le formule | per capire i numeri |
| moduli.md | un modulo alla volta: responsabilità, funzioni, strutture dati, come aggiungere un modello | per modificare il codice |
| configurazione.md | ogni chiave di config.toml, formato di domini.toml, esempi |
per cambiare un valore |
| output.md | file prodotti, colori, grafici, struttura del report, come leggere i messaggi | per leggere i risultati |
| test.md | come eseguire i test, cosa verifica ognuno, il segnale sintetico | per sviluppare |
| limiti.md | limiti noti, estensioni possibili, scelte progettuali | prima di estendere |
Convenzioni: le assunzioni hanno identificativi A1…A24 richiamati dagli altri file e dai commenti nel codice; le chiavi di configurazione sono scritte
in_questo_formato; le formule sono in LaTeX (servono un visualizzatore Markdown con supporto matematico: GitHub, VS Code, Obsidian).