@open3cl/engine 1.2.3 → 1.2.5

package/README.md

@@ -12,7 +12,7 @@
   </a>
 
 <h3 align="center">Open3CL</h3>
-  Implémentation open source du moteur Open3CL de l'ADEME.
+Implémentation open source du moteur Open3CL de l'ADEME.
   <p align="center">
 
 ![Javascript][Javascript]
@@ -50,8 +50,12 @@
 
 ## A propos du projet
 
-Open3CL est une librairie JavaScript open source, spécialement conçue pour faciliter le calcul des Diagnostics de Performance Énergétique (DPE).
-Elle implémente la norme définie dans [l'annexe 1 de l'arrêté du 31 mars 2021](https://rt-re-batiment.developpement-durable.gouv.fr/IMG/pdf/consolide_annexe_1_arrete_du_31_03_2021_relatif_aux_methodes_et_procedures_applicables.pdf). Elle est destinée aux développeurs qui souhaitent intégrer des calculs énergétiques précis et conformes à la réglementation dans leurs applications.
+Open3CL est une librairie JavaScript open source, spécialement conçue pour faciliter le calcul des Diagnostics de
+Performance Énergétique (DPE).
+Elle implémente la norme définie
+dans [l'annexe 1 de l'arrêté du 31 mars 2021](https://rt-re-batiment.developpement-durable.gouv.fr/IMG/pdf/consolide_annexe_1_arrete_du_31_03_2021_relatif_aux_methodes_et_procedures_applicables.pdf).
+Elle est destinée aux développeurs qui souhaitent intégrer des calculs énergétiques précis et conformes à la
+réglementation dans leurs applications.
 
 <p align="right">(<a href="#readme-top">Retour sommaire</a>)</p>
 
@@ -104,11 +108,67 @@ const dpeData = {
 const result = calcul_3cl(dpeData);
 ```
 
+## Variables d'environnements
+
+| Nom                     | Description                                                |
+| ----------------------- | ---------------------------------------------------------- |
+| ADEME_API_CLIENT_ID     | Client id pour l'api de l'ademe                            |
+| ADEME_API_CLIENT_SECRET | Client secret pour l'api de l'ademe                        |
+| CORPUS_DPES_FILE_PATH   | Chemin vers le dossier contenant tous les DPES téléchargés |
+
+Attention aux quotas sur l'api:
+
+- 100 requêtes / seconde
+- 1000 requêtes / minute
+- 10000 requêtes / jour
+
 <p align="right">(<a href="#readme-top">Retour sommaire</a>)</p>
 
-## Rapports
+## Lancement des tests sur des corpus de DPE
+
+Les tests de corpus consistent à analyser une liste de numéro de DPE présent dans un fichier CSV.
+Pour chaque DPE, le fichier est téléchargé si pas déjà présent en local, et il est envoyé à la librairie Open3CL.
+On analyse en sortie de la lib certaines valeurs que l'on compare aux valeurs du DPE initial. Le seuil de tolérance est
+fixé par défaut à 5%.
+La liste des valeurs analysées est la suivante:
+
+```javascript
+deperdition_mur,
+  deperdition_baie_vitree,
+  deperdition_plancher_bas,
+  deperdition_plancher_haut,
+  deperdition_porte,
+  deperdition_renouvellement_air,
+  hperm,
+  deperdition_pont_thermique,
+  surface_sud_equivalente,
+  besoin_ecs,
+  besoin_ch,
+  conso_auxiliaire_distribution_ecs,
+  conso_auxiliaire_generation_ch,
+  conso_auxiliaire_generation_ecs,
+  conso_ecs,
+  conso_ch,
+  conso_auxiliaire_distribution_ch,
+  conso_auxiliaire_ventilation,
+  ep_conso_5_usages,
+  ep_conso_5_usages_m2,
+  emission_ges_5_usages,
+  emission_ges_5_usages_m2;
+```
+
+- `npm run test:corpus`. Va générer 2 rapports de sortie au format csv (détaillé) et json (global)
+- `npm run test:corpus -- corpus-file-path=corpus.csv`. Chemin relatif vers le fichier de corpus à analyser
+  Par défaut, le corpus utilisé est présent ici : [test/corpus/corpus_dpe.csv](test/corpus/corpus_dpe.csv)
+- `npm run test:corpus -- dpes-folder-path=/home/user/dpes`. Chemin vers le dossier où les DPE seront téléchargés. Si un
+  fichier DPE est déjà présent dans ce dossier, il ne sera pas retéléchargé.
+
+### Résultats corpus
 
-Lister ici les rapports de tests avec stats sur le CORPUS DPE.
+| Version librairie | corpus                                | Taux d'erreur | Nb de DPES analysés | Nb en dessous tu taux d'erreur | Taux de réussite | Détail des valeurs                                                                                                  |
+| :---------------- | :------------------------------------ | :------------ | ------------------- | ------------------------------ | ---------------- | ------------------------------------------------------------------------------------------------------------------- |
+| 1.2.3             | corpus_dpe.csv                        | 5%            | 9980                | 4489                           | 45%              | [Voir le détail](https://open3cl.github.io/engine/reports/corpus?corpus_file=corpus_dpe.csv)                        |
+| 1.2.3             | dpe_immeuble_chauffage_individuel.csv | 5%            | 9998                | 3257                           | 32%              | [Voir le détail](https://open3cl.github.io/engine/reports/corpus?corpus_file=dpe_immeuble_chauffage_individuel.csv) |
 
 ## Roadmap
 
@@ -120,7 +180,8 @@ Lister ici les rapports de tests avec stats sur le CORPUS DPE.
   - [ ] DPE à l'immeuble
   - [ ] Photovoltaïque
 
-Voir la liste des [issues](https://github.com/Open3CL/engine/issues) pour avoir le détail complet des bugs et fonctionnalités en cours de réalisation.
+Voir la liste des [issues](https://github.com/Open3CL/engine/issues) pour avoir le détail complet des bugs et
+fonctionnalités en cours de réalisation.
 
 <p align="right">(<a href="#readme-top">Retour sommaire</a>)</p>
 

package/core/file/infrastructure/adapter/csv-parser.store.js

@@ -0,0 +1,20 @@
+import { parse } from 'fast-csv';
+
+export default class CsvParserStore {
+  /**
+   * @param stream {ReadStream}
+   * @param opts {import('fast-csv').ParserOptionsArgs}
+   * @param transform {import('fast-csv').RowTransformFunction}
+   * @return Promise<object[]>
+   */
+  parseFromStream(stream, opts, transform) {
+    const rows = [];
+    return new Promise((resolve, reject) => {
+      stream
+        .pipe(parse(opts).transform(transform))
+        .on('error', (error) => reject(error))
+        .on('data', (row) => rows.push(row))
+        .on('end', () => resolve(rows));
+    });
+  }
+}

package/core/file/infrastructure/adapter/csv-parser.store.spec.js

@@ -0,0 +1,28 @@
+import { beforeEach, describe, expect, it } from 'vitest';
+import CsvParserStore from './csv-parser.store.js';
+import { createReadStream } from 'node:fs';
+import { resolve } from 'node:path';
+
+describe('CsvParserStore', () => {
+  /** @type {CsvParserStore} **/
+  let store;
+
+  /** @type {ReadStream} **/
+  let stream;
+
+  beforeEach(() => {
+    store = new CsvParserStore();
+  });
+
+  describe('parseFromStream', () => {
+    it('should parse a csv file from a stream', () => {
+      stream = createReadStream(resolve('test/corpus/corpus_dpe.csv'));
+
+      return store
+        .parseFromStream(stream, {}, (data) => data)
+        .then((data) => {
+          expect(data).toBeDefined();
+        });
+    });
+  });
+});

package/engine.js

@@ -499,6 +499,9 @@ export function calcul_3cl(dpe) {
     ...conso
   };
 
+  const conso_coeff_1_9 = get_conso_coeff_1_9_2026(dpe);
+  logement.sortie.ep_conso = { ...logement.sortie.ep_conso, ...conso_coeff_1_9 };
+
   return dpe;
 }
 
@@ -527,3 +530,35 @@ export function get_classe_ges_dpe(dpe) {
     )
   };
 }
+
+/**
+ * Calcul de la nouvelle conso suite à la modification du coefficient pour le chauffage électrique
+ * Applicable uniquement à partir de janvier 2026
+ *
+ * {@link https://www.ecologie.gouv.fr/actualites/evolutions-du-calcul-du-dpe-reponses-vos-questions#:~:text=Les%20DPE%20r%C3%A9alis%C3%A9s%20avant%20le,%2DAudit%20de%20l'Ademe.}
+ *
+ * @param dpe {FullDpe}
+ * @returns {{ep_conso_5_usages_2026: number; ep_conso_5_usages_2026_m2: number; classe_bilan_dpe_2026: string}}
+ */
+export function get_conso_coeff_1_9_2026(dpe) {
+  const zc_id = dpe.logement.meteo.enum_zone_climatique_id;
+  const ca_id = dpe.logement.meteo.enum_classe_altitude_id;
+  const th = calc_th(dpe.logement.caracteristique_generale.enum_methode_application_dpe_log_id);
+
+  const ep_conso_5_usages_2026 =
+    (0.9 / 1.3) *
+      (Number(dpe.logement.sortie.ep_conso.ep_conso_5_usages) -
+        Number(dpe.logement.sortie.ef_conso.conso_5_usages)) +
+    Number(dpe.logement.sortie.ef_conso.conso_5_usages);
+
+  let Sh;
+  if (th === 'maison' || th === 'appartement')
+    Sh = Number(dpe.logement.caracteristique_generale.surface_habitable_logement);
+  else if (th === 'immeuble')
+    Sh = Number(dpe.logement.caracteristique_generale.surface_habitable_immeuble);
+
+  const ep_conso_5_usages_2026_m2 = Math.floor(ep_conso_5_usages_2026 / Sh);
+  const classe_bilan_dpe_2026 = classe_bilan_dpe(ep_conso_5_usages_2026_m2, zc_id, ca_id, Sh);
+
+  return { classe_bilan_dpe_2026, ep_conso_5_usages_2026_m2, ep_conso_5_usages_2026 };
+}

package/index.js

@@ -1,4 +1,4 @@
-import { calcul_3cl, get_classe_ges_dpe } from './engine.js';
-export { calcul_3cl, get_classe_ges_dpe };
+import { calcul_3cl, get_classe_ges_dpe, get_conso_coeff_1_9_2026 } from './engine.js';
+export { calcul_3cl, get_classe_ges_dpe, get_conso_coeff_1_9_2026 };
 import { Umur, Uph, Upb, Uporte, Ubv, Upt } from './3_deperdition.js';
 export { Umur, Uph, Upb, Uporte, Ubv, Upt };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@open3cl/engine",
-  "version": "1.2.3",
+  "version": "1.2.5",
   "description": "Open Source 3CL-DPE engine",
   "main": "index.js",
   "directories": {
@@ -15,14 +15,6 @@
     "test": "vitest run",
     "test:ci": "vitest run --coverage",
     "test:corpus": "node test/corpus/run_corpus_checks.js",
-    "test:corpus:bench:5": "npm run test:corpus -- threshold=5 && npm run test:corpus -- compatibility threshold=5",
-    "test:corpus:bench:6": "npm run test:corpus -- threshold=6 && npm run test:corpus -- compatibility threshold=6",
-    "test:corpus:bench:7": "npm run test:corpus -- threshold=7 && npm run test:corpus -- compatibility threshold=7",
-    "test:corpus:bench:8": "npm run test:corpus -- threshold=8 && npm run test:corpus -- compatibility threshold=8",
-    "test:corpus:bench:9": "npm run test:corpus -- threshold=9 && npm run test:corpus -- compatibility threshold=9",
-    "test:corpus:bench:10": "npm run test:corpus -- threshold=10 && npm run test:corpus -- compatibility threshold=10",
-    "test:corpus:bench": "npm run test:corpus:bench:5 && npm run test:corpus:bench:6 && npm run test:corpus:bench:7 && npm run test:corpus:bench:8 && npm run test:corpus:bench:9 && npm run test:corpus:bench:10",
-    "test:benchmark": "node inspect test/run_benchmark.js",
     "qa:lint": "eslint .",
     "qa:lint:fix": "npm run qa:lint -- --fix",
     "qa:duplication": "jscpd",
@@ -55,6 +47,8 @@
     "@semantic-release/github": "^10.0.2",
     "@types/node": "^20.12.4",
     "@vitest/coverage-v8": "^3.0.6",
+    "ansi-colors": "^4.1.3",
+    "cli-progress": "^3.12.0",
     "deep-object-diff": "^1.1.9",
     "eslint": "^8.57.0",
     "eslint-config-prettier": "^9.1.0",
@@ -66,6 +60,7 @@
     "fast-csv": "^5.0.2",
     "husky": "^9.0.11",
     "jscpd": "^3.5.10",
+    "piscina": "^5.1.2",
     "prettier": "^3.2.5",
     "pretty-quick": "^4.0.0",
     "semantic-release": "^23.0.6",