Open3CL

Implémentation open source du moteur Open3CL de l'ADEME.

Créer un bug · Créer une feature

Sommaire

1. A propos du projet
2. Démarrage
   • Pre-requis
   • Installation
   • Documentation
3. Usage
4. Rapports
5. Roadmap
6. Contribution
7. License
8. Contact
9. Acknowledgments

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. 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.

(Retour sommaire)

Démarrage

Pre-requis

Vous devez d'abord installer NodeJS en version 20 ou supérieure.

Installation

  npm install @open3cl/engine

Documentation

Lien à faire vers les wiki

(Retour sommaire)

Utilisation

import { calcul_3cl } from 'open3cl';

// Exemple d'objet JSON issu d'un fichier XML DPE
const dpeData = {
  numero_dpe: '2113E1018248X',
  statut: 'ACTIF',
  logement: {
    caracteristique_generale: {
      annee_construction: 1948,
      surface_habitable_logement: 49.96
    },
    installation_chauffage_collection: {
      installation_chauffage: [
        {
          description: 'Chaudière individuelle gaz standard',
          surface_chauffee: 49.96,
          generateur_chauffage_collection: {
            generateur_chauffage: [{ description: '...' }]
          }
        }
      ]
    }
  }
};

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

Attention aux quotas sur l'api:

• 100 requêtes / seconde
• 1000 requêtes / minute
• 10000 requêtes / jour

(Retour sommaire)

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:

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
• 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

Résultats des tests de corpus avec le mode de compatibilité activé.

Version librairie	corpus	Taux d'erreur	Nb de DPES analysés	Nb en dessous du taux d'erreur	Taux de réussite	Détail des valeurs
1.2.3	corpus_dpe.csv	5%	9980	4489	45%
1.2.3	dpe_immeuble_chauffage_individuel.csv	5%	9998	3257	32%
1.2.3	dpe_immeuble_chauffage_collectif.csv	5%	10000	5279	53%
1.2.3	dpe_immeuble_chauffage_mixte.csv	5%	10000	2728	27%
1.2.8	corpus_dpe.csv	5%	9980	4489	45%	Voir le détail
1.2.8	dpe_immeuble_chauffage_individuel.csv	5%	9998	5275 (+2018)	53% (+21%)	Voir le détail
1.2.8	dpe_immeuble_chauffage_collectif.csv	5%	10000	5747 (+468)	57% (+4%)	Voir le détail
1.2.8	dpe_immeuble_chauffage_mixte.csv	5%	10000	3142 (+414)	31% (+4%)	Voir le détail

Roadmap

• Site Open 3CL
• Refacto technique
• Rapports de tests
• Certification ADEME
• Fonctionnalités
  • DPE à l'immeuble
  • Photovoltaïque

Voir la liste des issues pour avoir le détail complet des bugs et fonctionnalités en cours de réalisation.

(Retour sommaire)

Contribution

Nous accueillons les contributions avec plaisir ! Si vous souhaitez améliorer Open3CL, veuillez :

• Forker le dépôt.
• Créer une branche pour vos modifications.
• Soumettre une pull request avec une description claire des changements apportés.
• Consultez le fichier CONTRIBUTING.md pour plus de détails.

Meilleurs contributeurs

(Retour sommaire)

Licence

Distribué sous la license GPL-3.0 license. Lire le fichier LICENSE pour plus d'informations.

(Retour sommaire)

Contact

Pour plus d'informations merci de nous contacter à cette adresse : [email protected]

(Retour sommaire)

Remerciements

A compléter

(Retour sommaire)