đïž Autres recettes
Les recettes de cette page ne sont pas nécessaires pour réussir le cours 420-SN1 : la façon de travailler du cours a changé, et d'autres recettes les ont remplacées.
Nous les conservons parce qu'elles contiennent de l'information utile au-delĂ du cours : pour un projet personnel, vos futurs cours en sciences ou votre curiositĂ©. đ§
đ Si vous cherchez comment faire quelque chose pour le cours, consultez plutĂŽt les recettes du menu de gauche.
- đ Notebook Jupyter
- đïž CrĂ©er un projet PyCharm
- đ„ CrĂ©er un rĂ©pertoire GitHub
- đ» Installer GitHub Desktop
- đ Git avec GitHub Desktop
Dans le cours, tout le code est écrit dans des fichiers Python (.py) exécutés dans PyCharm. C'est aussi le format attendu pour les exercices, les TP et les examens.
Les notebooks restent toutefois un outil incontournable en sciences : vous les croiserez sûrement dans vos cours de sciences, à l'université ou en stage de recherche (par exemple dans Google Colab).
Les notebooks Jupyter sont parfaits pour combiner texte, code et rĂ©sultats dans un seul fichier interactif. Ils contiennent Ă la fois, de façon intermĂȘlĂ©e :
- des blocs de texte (en format markdown ou html)
- des blocs de code Python qui peuvent ĂȘtre exĂ©cutĂ©s
- des résultats d'exécution
- des graphiques
- des images
Ils sont largement utilisés en sciences pour la recherche, l'exploration de données et l'enseignement.
CrĂ©er un notebookâ
Pour créer un nouveau notebook :
- Créer un projet PyCharm (ou en ouvrir un existant).
- Dans l'arborescence des fichiers du projet Ă gauche, cliquer-droit sur le dossier oĂč on veut crĂ©er le notebook.
- Choisir New > Jupyter Notebook.
- Donner un nom au notebook (par exemple
mon_premier_notebook) et appuyer sur â. - Un fichier avec l'extension
.ipynbest créé dans l'arborescence des fichiers (par exemplemon_premier_notebook.ipynb) et s'ouvre dans un nouvel onglet. - Le notebook contient une premiĂšre cellule vide. Pour en ajouter d'autres, il suffira de cliquer sur le bouton ïŒ dans la barre d'outils en haut.
Ăcrire du texteâ
- Cliquer sur une cellule existante, ou en ajouter une nouvelle avec le bouton ïŒ.
- Dans la barre d'outils du notebook, changer le type de cellule de Code Ă Markdown.
- Taper le texte en utilisant la syntaxe Markdown (voir exemple ci-dessous).
- Appuyer sur
Shiftâ pour afficher le rendu formatĂ©.
Exemple de Markdown :â
# Titre principal
Voici du texte en **gras**, *italique* et un [lien](https://jupyter.org).
- Une liste
- Ă puces
1. Une liste
2. numérotée
Voici un bloc de code non exécutable :
```python
def salut():
print("Bonjour!")
```
RĂ©sultat affichĂ© :â
Titre principal
Voici du texte en gras, italique et un lien.
- Une liste
- Ă puces
- Une liste
- numérotée
Voici un bloc de code non exécutable :
def salut():
print("Bonjour!")
Ăcrire du codeâ
- Cliquer sur une cellule existante, ou en ajouter une nouvelle.
- Laisser le type de cellule sur Code.
- Taper du code Python comme dans un fichier
.py. - Appuyer sur
Shiftâ pour exĂ©cuter la cellule. - Observer le rĂ©sultat qui s'affiche directement sous la cellule.
Exemple :â
x = 2 + 2
print(f'Le résultat est {x}')
RĂ©sultat affichĂ© :â
Le résultat est 4
ExĂ©cuter du codeâ
- Cliquer dans la cellule contenant du code Python.
- Appuyer sur
Shiftâ (ou cliquer sur le bouton â¶ dans la barre d'outils). - Pour exĂ©cuter toutes les cellules du notebook d'un coup, cliquer sur le bouton â¶â¶ dans la barre d'outils.
Exemple :â
## Définir une fonction
def bonjour(nom):
print(f'Bonjour, {nom}!')
## Appeler la fonction
bonjour('Marie')
RĂ©sultat affichĂ© :â
Bonjour, Marie!
Astucesâ
- Tu peux dĂ©placer une cellule vers le haut ou le bas Ă l'aide des flĂšches â â dans la barre d'outils.
- Pour insĂ©rer une cellule au-dessus ou au-dessous, utiliser les boutons ïŒ ou Insert Cell Below/Above.
- Les fichiers
.ipynbpeuvent ĂȘtre ouverts dans d'autres outils comme JupyterLab ou VS Code. - Les cellules Markdown peuvent contenir des titres, des listes, des images, des liens, et mĂȘme des Ă©quations mathĂ©matiques en format TeX :
Ăcrire des Ă©quations mathĂ©matiques (TeX)â
- Cliquer sur une cellule existante ou en créer une nouvelle.
- Changer son type en Markdown.
- Insérer l'équation LaTeX entre
$$ ... $$pour une formule centrée, ou entre$ ... $pour une formule en ligne. - Appuyer sur
Shiftâ pour afficher le rendu.
Exemple (formule centrĂ©e) :â
La formule quadratique est :
$$x = \frac{-b \pm \sqrt{b^2 - 4ac}}{2a}$$
Exemple (formule en ligne) :â
La solution est donnée par $x = \frac{-b \pm \sqrt{b^2 - 4ac}}{2a}$.
RĂ©sultat affichĂ© :â
La formule quadratique est :
La solution est donnée par .
Dans le cours, vous n'avez pas Ă crĂ©er de projet vous-mĂȘme : vos dĂ©pĂŽts (exercices, TP) sont créés pour vous lorsque vous acceptez un dĂ©pĂŽt Classroom 50. Il suffit ensuite de les cloner dans PyCharm.
Cette recette demeure utile pour un projet personnel, ou si vous installez PyCharm sur votre ordinateur et voulez faire un premier essai.
Un projet PyCharm est un dossier contenant tous les fichiers liés à un programme Python. Il contient habituellement :
- des fichiers
.py(code Python) - un environnement virtuel (
venv) pour gérer les dépendances - d'autres fichiers comme des notebooks Jupyter, des images, ou des fichiers Markdown
Ătapes pour crĂ©er un projetâ
- Ouvrir PyCharm.
- Sur lâĂ©cran dâaccueil, cliquer sur New Project (ou File > New Project si un autre projet est dĂ©jĂ ouvert).
- Choisir un emplacement pour le projet, idéalement dans votre répertoire GitHub
(par exemple :
Desktop/mon_repo/nom_du_nouveau_projet). - Choisir un environnement Python :
- Cocher Create a welcome script pour qu'un fichier
main.pysoit créé automatiquement. - Laisser lâoption Project venv cochĂ©e pour crĂ©er un environnement isolĂ©.
- VĂ©rifier que lâinterprĂ©teur sĂ©lectionnĂ© est bien une version de Python 3.x.
- Cocher Create a welcome script pour qu'un fichier
- Cliquer sur Create.
- Si vous avez déjà un projet ouvert, cliquer sur New Window pour ouvrir le nouveau projet dans un nouvel onglet.
Comprendre la structure du projetâ
Une fois le projet créé, PyCharm affiche :
- un dossier principal (nom du projet)
- un dossier
venv/contenant lâenvironnement virtuel - un fichier
main.py(optionnel) - lâĂ©diteur principal au centre, lâarborescence des fichiers Ă gauche
Ajouter un premier fichierâ
- Dans la colonne de gauche, cliquer-droit sur le dossier du projet.
- Choisir New > Python File.
- Donner un nom au fichier (ex :
test) et appuyer sur â. - Un nouveau fichier
test.pyest créé.
Astucesâ
- Toujours crĂ©er un projet avant dâĂ©crire du code, pour bien organiser vos fichiers.
- Ăviter les accents, espaces ou caractĂšres spĂ©ciaux dans les noms de dossiers.
- Le projet peut contenir aussi des notebooks Jupyter, des fichiers Markdown, etc.
Dans le cours, vos dépÎts GitHub sont créés automatiquement lorsque vous acceptez un dépÎt Classroom 50, et votre enseignant y a déjà accÚs : inutile de créer un dépÎt ou d'inviter un collaborateur.
Ces étapes restent pertinentes pour héberger vos propres projets sur GitHub (projet personnel, portfolio, travail d'équipe dans un autre cours).
- Allez sur github.com et connectez-vous Ă votre compte
- Cliquez sur l'onglet
Repositoriesen haut de la page - Cliquez sur le bouton vert
Newen haut Ă droite - Dans la section
General:-
Dans le champ
Repository name, nommez votre dépÎt en suivant les directives de votre enseignant.
Par exemple, pour votre dĂ©pĂŽt de code contenant les exercices du cours, le format attendu est :A26-GrXXXX-MATRICULE-PRENOM-NOM(ex : A26-Gr1010-123456-John-Doe) oĂčXXXXest votre numĂ©ro de groupe,MATRICULEvotre matricule Ă©tudiant,PRENOMetNOMvos prĂ©nom et nom de famille. -
Le champ
Descriptionest optionnel, mais il est recommandé d'y décrire au minimum le rÎle du dépÎt.
Par exemple : "Exercices réalisés dans le cadre du cours 420-SN1".
-
- Dans la section
Configuration:-
Choose visibility: sélectionnezPrivate
Votre dépÎt ne sera visible que par vous et les collaborateurs que vous invitez. -
Add README: activez le bouton pour le mettre ĂON
Le contenu de ce fichier s'affiche sur la page d'accueil de votre dépÎt et sert de carte de visite pour votre projet.
GitHub créera automatiquement un fichierREADME.mden reprenant la description que vous avez saisie plus haut. -
Add .gitignore: sélectionnezPython
Cela exclut automatiquement les fichiers inutiles de votre dépÎt de code. -
Add license: laissez ĂNo license
-
- Cliquez sur
Create repository
đ„ Ajouter un collaborateur Ă votre dĂ©pĂŽtâ
Une fois votre dépÎt créé, vous devez y inviter votre enseignant comme collaborateur pour qu'il puisse consulter votre code. Vous pouvez trouver le nom de votre enseignant sur votre horaire de cours reçu en début de session.
- Sur la page de votre dépÎt, cliquez sur l'onglet
Settings - Dans le menu de gauche, cliquez sur
Collaborators - Cliquez sur le bouton
Add people - Entrez le nom d'utilisateur GitHub de votre enseignant, puis cliquez sur
Add [nom] to this repository - Votre enseignant recevra une invitation par courriel qu'il devra accepter
Voici les noms d'utilisateurs GitHub des enseignants :
| Enseignant | Nom d'utilisateur GitHub |
|---|---|
| Joris | jorisdeguet |
| Kevin | Kevvix |
| Mathieu | mathieudupont |
Dans le cours, Git s'utilise directement dans PyCharm (voir la recette đ Git avec PyCharm) : il n'est donc pas nĂ©cessaire d'installer GitHub Desktop.
GitHub Desktop demeure une application simple et visuelle pour gérer vos dépÎts GitHub, pratique si vous travaillez avec un autre éditeur que PyCharm.
GitHub Desktop est l'outil servant à synchroniser le contenu de vos répertoires GitHub sur votre ordinateur avec la version dans le nuage.
Pour installer GitHub Desktop sur votre ordinateur personnel, suivez les étapes suivantes :
- Aller sur le site de GitHub Desktop.
- Cliquer sur "Download for Windows (64 bit)".
- Double-cliquer sur le fichier "GitHubDesktopSetup-x64.exe" dans vos téléchargements.
- Suivre les instructions d'installation (l'installation devrait se faire automatiquement).
- Se connecter Ă l'aide de votre compte GitHub.
Dans le cours, on clone, on fait des commit-push et on rĂ©cupĂšre les modifications directement dans PyCharm : suivez plutĂŽt la recette đ Git avec PyCharm.
Cette façon de faire reste utile si vous travaillez un jour avec un autre éditeur que PyCharm (par exemple VS Code), ou si vous préférez une application dédiée pour gérer vos dépÎts GitHub.
Voici la procédure à suivre lorsque vous vous connectez à un poste au cégep, en utilisant GitHub Desktop :
đ GitHub Desktop doit ĂȘtre installĂ© sur l'ordinateur. Sinon, suivez d'abord la recette đ» Installer GitHub Desktop.
1ïžâŁ Cloner un rĂ©pertoire GitHubâ
- Ouvrez GitHub Desktop
- Allez dans le menu
File>Clone repository... - Cliquez sur
Sign inet connectez-vous avec votre compte GitHub - Une fois connecté, sous l'onglet
GitHub.com, vous verrez la liste de vos répertoire- Sélectionnez le répertoire que vous voulez cloner (par exemple,
Cours_420-SN1) - Cliquez sur
Choose...pour choisir l'emplacement local oĂč cloner le rĂ©pertoire- đ Naviguez et choisissez le
Bureau
- đ Naviguez et choisissez le
- Cliquez sur
Clone
- Sélectionnez le répertoire que vous voulez cloner (par exemple,
- Votre répertoire est maintenant cloné (copié) localement sur le bureau de votre poste de travail
- Gardez GitHub Desktop ouvert pour la suite des opérations.
2ïžâŁ Ouvrir un projet dans PyCharmâ
- Ouvrez PyCharm
- Cliquez sur le bouton
Open(ou allez dans le menuFile>Open...) - Naviguez jusqu'au dossier de votre répertoire cloné (normalement sur le
Bureau) - Dans votre répertoire, sélectionnez le dossier du projet que vous voulez ouvrir (par exemple,
Exemples_exercices)- đ Ne sĂ©lectionnez pas le repo entier, mais le dossier spĂ©cifique du projet Ă l'intĂ©rieur du repo
- Si vous n'avez pas encore créé de projet dans le répertoire, vous pouvez créer un nouveau dossier pour votre nouveau projet (cliquez sur
Nouveau dossieren haut Ă gauche)
- Une fois le dossier du projet sélectionné (en bleu), cliquez sur
Select Folder- Cliquez sur
Trust Projectsi PyCharm vous le demande - đ PyCharm va ouvrir le projet et indexer les fichiers (cela peut prendre quelques instants)
- Cliquez sur
- Vous pouvez maintenant éditer et exécuter les fichiers Python de votre projet dans PyCharm.
3ïžâŁ Faire des commit-pushâ
MĂȘme si PyCharm sauvegarde localement les modifications que vous faites dans vos fichiers, elles ne sont pas sauvegardĂ©es dans votre compte GitHub. Si une panne d'Ă©lectricitĂ© survenait, vous perdriez toutes vos modifications non poussĂ©es sur GitHub. Il est donc important de faire des commit-push rĂ©guliĂšrement, par exemple aprĂšs chaque exercice complĂ©tĂ© :
- Allez sur GitHub Desktop.
- Vous verrez les fichiers modifiés dans l'onglet
Changes- Si vous cliquez sur un fichier, vous verrez les modifications apportées à ce fichier
- Dans le champ
Summary, ajoutez un message de commit décrivant vos modifications (par exemple,Exercice 1 complété) - Pour envoyer vos modifications sur GitHub, cliquez sur les boutons bleus :
Commit to mainPush origin
- đ N'oubliez pas de faire
PushaprÚs chaqueCommit. Tant que vous ne faites pasPush, vos modifications ne sont pas sauvegardées sur GitHub.
đ§âđ» Ordinateur personnelâ
Si vous travaillez sur votre ordinateur personnel :
- Assurez-vous d'avoir installé GitHub Desktop et PyCharm
- Clonez votre rĂ©pertoire GitHub sur votre ordinateur personnel en suivant la mĂȘme procĂ©dure que ci-dessus
- đ Mais vous n'avez pas besoin de le cloner Ă chaque fois, seulement la premiĂšre fois
- Ouvrez le projet dans PyCharm comme décrit ci-dessus
- N'oubliez pas de faire des commit-push réguliÚrement pour sauvegarder vos modifications sur Git
Si vous travaillez sur plusieurs ordinateurs (par exemple, votre ordinateur personnel et un poste au cégep), vous devez toujours synchroniser vos modifications entre les deux ordinateurs pour éviter des conflits.
Chaque fois que vous revenez travailler sur votre ordinateur personnel, vous devez récupérer les modifications que vous avez faites sur un autre ordinateur (par exemple, au cégep) avant de continuer à travailler sur vos fichiers.
Pour cela, dans GitHub Desktop, cliquez sur les boutons bleus :
Fetch originPull origin
C'est l'équivalent de Commit-Push mais dans l'autre sens : vous récupérez les modifications que vous avez faites sur un autre ordinateur.
- đ Si vous ne faites pas cela avant de continuer Ă travailler sur vos fichiers sur votre ordinateur personnel, vous risquez d'avoir des conflits lorsque vous essayerez de faire un
Commit-Push.