\n\n\n\nModèle de calcul de l'empreinte climat personnelle.\n\n
\n\n## Utilisation\n\nVous pouvez parcourir le modèle grâce à sa [documentation en\nligne](https://nosgestesclimat.fr/documentation) ou bien utiliser le paquet npm\n`@incubateur-ademe/nosgestesclimat` :\n\n```sh\nyarn add @incubateur-ademe/nosgestesclimat\n```\n\nChaque modèle régional peut être importé séparément en anglais ou en français en suivant la structure suivante :\n\n```ts\nimport rules from '@incubateur-ademe/nosgestesclimat/co2-model.-lang..json'\n```\n\nExemple d'utilisation :\n\n```ts\nimport rules from '@incubateur-ademe/nosgestesclimat/public/co2-model.FR-lang.fr.json'\nimport Engine from 'publicodes'\n\nconst engine = new Engine(rules)\nconsole.log(engine.evaluate('bilan'))\n```\n\n## Écriture des modèles du simulateur en bref\n\nLe modèle d'empreinte climat personnelle est écrit dans un français le plus\nlisible possible :\n\n```yaml\n# Premier extrait\ndouche . litres par minute:\n unité: l/minute\n formule:\n variations:\n - si: pomme de douche économe\n alors: 9\n - sinon: 18\n\n# Deuxième extrait\ntransport . avion . coefficient de forçage radiatif:\n description: >\n Le forçage radiatif, c'est la capacité d'une émission de gaz à rechauffer la\n terre.\n 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.\n 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.\n formule: 2\n note: |\n Plus d'informations ici:\n - https://www.carbonindependent.org/sources_aviation.html\n - http://www.bilans-ges.ademe.fr/forum/viewtopic.php?f=20&t=4009&sid=dea7e08c81c2f723b803d27e7e2a8797\n - https://fr.wikipedia.org/wiki/Impact_climatique_du_transport_a%C3%A9rien#Pond%C3%A9ration_des_%C3%A9missions\n```\n\n:pen: Suivez [le guide pour\ncontribuer](https://github.com/incubateur-ademe/nosgestesclimat/blob/master/CONTRIBUTING.md).\n\nTous les modèles sont dans [le dossier\n`data`](https://github.com/incubateur-ademe/nosgestesclimat/tree/master/data).\n\nIls reposent sur le nouveau langage de programmation\n[`publicodes`](https://publi.codes) et développé dans le cadre de\nhttps://beta.gouv.fr.\n\n## Développement\n\nLa branche par défaut du dépôt est `preprod`, notre branche de développement.\n\n`master` est la branche depuis laquelle code est versionné et publié sur NPM.\n\n### QuickDoc\n\nPour faciliter le développement, nous avons mis en place un outil de\ndéveloppement local. Cet outil permet de visualiser la documentation (basée sur\n[`@publicodes/react-ui`](https://publi.codes/docs/api/react-ui)) et les\nrésultats de la compilation des modèles et des personas, ainsi que comparer les\nrésultats avec les versions en production.\n\n```bash\n# installe les dépendances\nyarn && cd quick-doc && yarn\n\n# lance le serveur de développement en charge de compiler les modèles et les personas\nyarn dev\n\n# lance le client de la documentation\nyarn doc\n```\n\n### CI\n\nLe projet utilise plusieurs GitHub Actions pour automatiser les tâches de\ndéveloppement.\n\nPour chaque _pull request_, les actions suivantes sont exécutées :\n\n- `upload-compilation-result.yaml` : compile les modèles et les personas (`yarn compile`) et exécute\n les tests (`yarn test:personas` et `yarn test:optim`)\n- `pr-updater.yaml` : utilise l'artifact généré par\n `upload-compilation-result.yaml` pour mettre à jour la PR avec les résultats\n de la compilation et des tests\n\nPour chaque _push_ sur la branche `master`, le workflow `packaging.yaml` est exécuté.\nSi la version du paquet npm est incrémentée, alors :\n\n- une nouvelle _release_ GitHub est créée\n- le modèle est publié dans\n une nouvelle version du paquet npm\n [`@incubateur-ademe/nosgestesclimat`](https://www.npmjs.com/package/@incubateur-ademe/nosgestesclimat)\n\n### Site\n\nPour lancer l'app en local, rendez-vous [côté site](https://github.com/incubateur-ademe/nosgestesclimat-site-nextjs) !\n\nA noter que le dépôt [nosgestesclimat-site](https://github.com/incubateur-ademe/nosgestesclimat-site-nextjs) était utilisé avant la refonte Next et n'est aujourd'hui plus maintenu. Néanmoins, nous le gardons pour la richesse de ses issues.\n","readmeFilename":"README.md"}