Tutoriel : un nouveau modèle de calcul pour mon pays / ma région

<aside> 🇬🇧 ENGLISH VERSION This guide is also available in English : Add new region [EN]

</aside>

<aside> ⚠️ L'internationalisation de Nos Gestes Climat est complexe : il n'est pas seulement question de simple traduction linguistique mais de la mise en place d'une solution permettant d'adapter la langue et le modèle de calcul en fonction du pays.

En 2024, l’équipe a décidé de dédier moins de temps au sujet international mais nous ferons au mieux pour vous accompagner si votre région est manquante ou si vous souhaité proposer des améliorations.

</aside>

Comment contribuer ?

Github est une plateforme dédiée au code et aux discussions. Cette page vous explique les rudiments du langage utilisé pour la mise en place du modèle de calcul. Pour contribuer, inutile d'être développeur, le langage est intuitif et notre infrastructure vous permet de publier une version de votre modèle directement sans se plonger dans le code du site.

Étape 1 : Créer un compte Github

Github est une plateforme particulièrement intéressante pour la gestion des versions du code. Pour commencer votre déclinaison, créer votre compte Github et rendez vous sur le dépôt : @incubateur-ademe/nosgestesclimat.

Étape 2 : Chercher le modèle de votre région

Rendez-vous dans le dossier data/i18n/models contenant les modèles des régions supportées par Nos Gestes Climat !

<aside> ℹ️ REMARQUE Il faut savoir que ces fichiers contiennent de règles de calcul (format yaml) correspondant aux règles du modèle de base français (dans le dossier data).

</aside>

Votre modèle n'est pas encore supporté dans NGC ?

Créez le votre : votre fichier doit être nommé avec le code de votre pays suivi de l'extension .publicodes, par exemple pour le Belgique, UK-fr.publicodes (pour le modèle en français). Commencez ensuite par écrire votre première règle : params contenant les caractéristiques de votre région (les attributs nom et code sont obligatoires) :

Exemple pour la Grande Bretagne:

params:
  code: UK
  nom: Royaume-Uni
  gentilé: anglaise
  drapeau: GB

Suivez ensuite les étapes du point suivant pour avancer sur votre modèle.

Vous souhaitez proposer un changement pour un modèle déjà existant ?

Vous pouvez vous rendre dans le fichier correspondant à votre région (selon son code et langue d'écriture du modèle).

L'idée est ensuite de réécrire dans ce fichier les règles du modèle "de base", français, que vous souhaitez modifier en veillant à reporter exactement les clés du modèle (= nom des règles).

Par exemple, le mix électrique est défini dans la règle intensité électricité du fichier data/divers/commun.publicodes. Pour modifier sa valeur et son titre dans le modèle nouvellement créé, il faut réécrire cette règle avec les bons attributs qui viendront écraser ceux du modèle français lors de la compilation.

Exemple pour la Grande Bretagne: