Modèle de calcul de l'empreinte climat personnelle.

Utilisation

Vous pouvez parcourir le modèle grâce à sa documentation en ligne ou bien utiliser le paquet npm @incubateur-ademe/nosgestesclimat :

yarn add @incubateur-ademe/nosgestesclimat

Chaque modèle régional peut être importé séparément en anglais ou en français en suivant la structure suivante :

import rules from '@incubateur-ademe/nosgestesclimat/co2-model.<REGION>-lang.<LOCALE>.json'

Exemple d'utilisation :

import rules from '@incubateur-ademe/nosgestesclimat/public/co2-model.FR-lang.fr.json'
import Engine from 'publicodes'

const engine = new Engine(rules)
console.log(engine.evaluate('bilan'))

Écriture des modèles du simulateur en bref

Le modèle d'empreinte climat personnelle est écrit dans un français le plus lisible possible :

# Premier extrait
douche . litres par minute:
  unité: l/minute
  formule:
    variations:
      - si: pomme de douche économe
        alors: 9
      - sinon: 18

# Deuxième extrait
transport . avion . coefficient de forçage radiatif:
  description: >
    Le forçage radiatif, c'est la capacité d'une émission de gaz à rechauffer la
    terre.
    Un vol émet du CO₂, mais aussi d'autres gaz, ainsi que de la vapeur libérée en haute altitude. Le forçage radiatif de ces émissions est conséquent et doit donc être pris en compte, mais c'est une estimation très compliquée.
    L'effet de la vapeur d'eau est temporaire : elle disparaît à court-terme par rapport au CO₂ qui reste très longtemps présent. Son effet n'en reste pas moins massif.
  formule: 2
  note: |
    Plus d'informations ici:
    - https://www.carbonindependent.org/sources_aviation.html
    - http://www.bilans-ges.ademe.fr/forum/viewtopic.php?f=20&t=4009&sid=dea7e08c81c2f723b803d27e7e2a8797
    - https://fr.wikipedia.org/wiki/Impact_climatique_du_transport_a%C3%A9rien#Pond%C3%A9ration_des_%C3%A9missions

:pen: Suivez le guide pour contribuer.

Tous les modèles sont dans le dossier data.

Ils reposent sur le nouveau langage de programmation publicodes et développé dans le cadre de https://beta.gouv.fr.

Développement

La branche par défaut du dépôt est preprod, notre branche de développement.

master est la branche depuis laquelle code est versionné et publié sur NPM.

QuickDoc

Pour faciliter le développement, nous avons mis en place un outil de développement local. Cet outil permet de visualiser la documentation (basée sur @publicodes/react-ui) et les résultats de la compilation des modèles et des personas, ainsi que comparer les résultats avec les versions en production.

# installe les dépendances
yarn && cd quick-doc && yarn

# lance le serveur de développement en charge de compiler les modèles et les personas
yarn dev

# lance le client de la documentation
yarn doc

CI

Le projet utilise plusieurs GitHub Actions pour automatiser les tâches de développement.

Pour chaque pull request, les actions suivantes sont exécutées :

• upload-compilation-result.yaml : compile les modèles et les personas (yarn compile) et exécute les tests (yarn test:personas et yarn test:optim)
• pr-updater.yaml : utilise l'artifact généré par upload-compilation-result.yaml pour mettre à jour la PR avec les résultats de la compilation et des tests

Pour chaque push sur la branche master, le workflow packaging.yaml est exécuté. Si la version du paquet npm est incrémentée, alors :

• une nouvelle release GitHub est créée
• le modèle est publié dans une nouvelle version du paquet npm @incubateur-ademe/nosgestesclimat

Site

Pour lancer l'app en local, rendez-vous côté site !

A noter que le dépôt nosgestesclimat-site était utilisé avant la refonte Next et n'est aujourd'hui plus maintenu. Néanmoins, nous le gardons pour la richesse de ses issues.