/gch-python

Collection d'exemples de programmation Python en Génie déployés grâce à JupyterLite sur GitHub Pages 🚀

Primary LanguageJupyter NotebookMIT LicenseMIT

Collection d'exemples de programmation Python en Génie

Build and Deploy lite-badge

Introduction

Cette collection d'exemples est un outil d’auto-apprentissage destiné à couvrir l’ensemble des approches de programmation scientifique en génie à l'aide d'exemples concrets.

Ces exemples sont groupés en thèmes scientifiques qui sont couramment vu en génie chimique. Chaque thème est présenté sous forme d'un notebook Jupyter qui permet la modification et l'exécution du code.

Ce repo

Le déploiement utilise JupyterLite afin de pouvoir ouvrir et exécuter des notebook Jupyter directement dans le navigateur. L'ensemble du contenu dans le dossier content est déployé de façon automatique en utilisant des Github Actions tirées du template fourni par JupyterLite. Chaque commit sur main enclenche l'action.

Le dossier template contient un notebook Jupyter qui sert de gabarit pour des nouveaux thèmes. Il contient tous les émojis et la structure Markdown à respecter.

Le module pre-commit est utilisé pour formatter automatiquement le code avant chaque commit.

Pour toute question ou commentaires, ne pas hésiter à ouvrir une Issue.

Installation

Cloner le repo avec le CLI ou Github Desktop.

git clone https://github.com/gch-poly/gch-python.git

Naviguer dans le dossier gch-python.

Installer pre-commit et l'initialiser sur le repo.

pip install pre-commit
pre-commit install