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);

(Retour sommaire)

Rapports

Lister ici les rapports de tests avec stats sur le CORPUS DPE.

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 : open3cl@redfroggy.fr

(Retour sommaire)

Remerciements

A compléter

(Retour sommaire)