@incubateur-ademe/nosgestesclimat 3.3.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Datagir
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,75 @@
+
+<div align="center">
+  <h3 align="center">
+	<big>Nos Gestes Climat</big>
+  </h3>
+  <p align="center">
+   <a href="https://github.com/incubateur-ademe/nosgestesclimat/issues">Report Bug</a>
+   •
+   <a href="https://nogestesclimat.fr">nosgestesclimat.fr</a>
+   •
+   <a href="https://github.com/incubateur-ademe/nosgestesclimat-site-nextjs">Code du site</a>
+  </p>
+
+<!-- ![CI][ci-link] ![NPM][npm-link] -->
+Modèle de calcul de l'empreinte climat personnelle.
+
+</div>
+
+## Utilisation
+
+Vous pouvez parcourir le modèle grâce à ça [documentation en
+ligne](https://nosgestesclimat.fr/documentation) ou bien utiliser le paquet npm
+`@incubateur-ademe/nosgestesclimat` :
+
+```sh
+yarn add @incubateur-ademe/nosgestesclimat
+```
+
+```ts
+import { rules } from "@incubateur-ademe/nosgestesclimat";
+import Engine from "publicodes";
+
+const engine = new Engine(rules);
+console.log(engine.evaluate("bilan"))
+```
+
+## Écriture des modèles du simulateur
+
+Le modèle d'empreinte climat personnelle est écrit dans un français le plus
+lisible possible :
+
+```yaml
+# 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](https://github.com/incubateur-ademe/nosgestesclimat/blob/master/CONTRIBUTING.md).
+
+Tous les modèles sont dans [le dossier
+`data`](https://github.com/incubateur-ademe/nosgestesclimat/tree/master/data).
+
+Ils reposent sur le nouveau langage de programmation
+[`publicodes`](https://publi.codes) et développé dans le cadre de
+https://beta.gouv.fr.