Merge pull request #6 from Ouranosinc/majdocum

maj readme et clarification des objectifs

README.ipynb

@@ -9,33 +9,50 @@
    "source": [
     "# Librarie d'analyses de base en science du climat (LabSc)\n",
     "\n",
-    "**Objectifs**\n",
+    "## Objectifs\n",
     "\n",
-    "L'objectif principal de *LabSc* est de construire une collection d'analyses élémentaires aux projets, à la recherche et développement, ainsi qu'à la synthèse de l'information climatique. \n",
+    "L'objectif principal de *LabSc* est de construire une collection d'analyses élémentaires pour soutenir la recherche et le développement en sciences du climat. \n",
     "\n",
     "Plus spécifiquement, *LabSc* vise à:   \n",
-    "- Démocratiser et partager des analyses au-delà des projets et des équipes en favorisant la collaboration et les échanges.\n",
-    "- Former les employés et renfocer leurs capacités sur les meilleures pratiques autant aux niveaux scientifique que technique.\n",
-    "- Rendre disponibles des blocs de code pouvant être réutilisés dans différents contextes.\n",
-    "- Structurer les analyses de l'équipe en une base de connaissance pour la mémoire à long terme.\n",
+    "- Démocratiser des méthodes d'analyses\n",
+    "- Clarifier et uniformiser des méthodologies\n",
+    "- Former des scientifiques du climat et renforcer leurs capacités\n",
+    "- Favoriser les échanges et les collaborations\n",
     "\n",
-    "**Interface**\n",
+    "## Environnement d'utilisation\n",
     "\n",
-    "Pour le moment l'interface est une [table des matières Markdown](index.ipynb) avec des liens vers les notebooks et autres ressources. Éventuellement, nous pourrions utiliser une plateforme plus sophistiquée (p. ex. [Quarto](https://quarto.org/)) permettant d'organiser dynamiquement les notebooks à partir de leur contenu.\n",
+    "- Ce projet est développé pour une utilisation directe sur la plateforme [PAVICS](https://pavics.ouranos.ca/).\n",
+    "- Un version récente de LabSc est disponible sur PAVICS [ici](https://pavics.ouranos.ca/jupyter/hub/user-redirect/lab/tree/public/leduc-public/LabSc)\n",
+    "- La [table des matières](index.ipynb) est le point de départ pour naviguer entre les notebooks.\n",
     "\n",
-    "**Comment contribuer**\n",
+    "## Règles d'or pour le développement des notebooks\n",
     "\n",
-    "*Étapes à suivre:*  \n",
-    "1. Créer un notebook en se référant au canevas donné [ici](labsc-notebooks/canevas_notebook.ipynb).\n",
-    "2. Mettre à jour de la [table des matières](index.ipynb).\n",
-    "3. ... TODO\n",
+    "- S'assurer que la méthodologie soit transparente en utilisant des fonctions de bas niveau, par exemple:\n",
+    "  - xarray pour les calculs de base, xclim pour le calcul d'indicateurs complexes. \n",
+    "- Utilisation du français dans les textes. \n",
+    "- Commenter le code.\n",
     "\n",
+    "<!--\n",
+    "## Comment réutiliser ou citer un notebook\n",
+    "TODO\n",
+    "-->\n",
     "\n",
-    "*Règles d'or:*\n",
-    "- Utilisation du français pour les textes. \n",
-    "- Commenter le code (français ou anglais).\n",
-    "- Utilisation de fonctions de base en Python, comme xarray pour la plupart des calculs et xclim lorsque des calculs d'indicateurs sont nécessaires. \n",
-    "- Donner un titre explicatif.\n"
+    "## Comment contribuer\n",
+    "\n",
+    "### Membres:\n",
+    "1. Cloner le répertoire et créer une nouvelle branche.\n",
+    "2. Créer un nouveau notebook à partir du [canevas](labsc-notebooks/canevas_notebook.ipynb).\n",
+    "3. Mettre à jour la table des matières.\n",
+    "4. Pousser la branche et créer une proposition de fusion (*pull request*).\n",
+    "\n",
+    "### Contributeurs externes:\n",
+    "\n",
+    "1. Dupliquer le dépôt dans son compte GitHub\n",
+    "2. Cloner le répertoire et créer une nouvelle branche.\n",
+    "3. Créer un nouveau notebook à partir du [canevas](labsc-notebooks/canevas_notebook.ipynb).\n",
+    "4. Mettre à jour la table des matières.\n",
+    "5. Envoyer une proposition de fusion depuis son compte.\n",
+    "\n"
    ]
   },
   {