diff --git a/README.md b/README.md index 77bed9a1bb404d73008653cab983cbb8812b8ccc..6e93beee06d6b28c010c88447f484fb319913eb3 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,26 @@ -# Référentiel de projets Python - Service commun d'électronique +<h2>Référentiel de projets Python - Service commun d'électronique<h/2> -Bienvenue dans ce référentiel ! Vous trouverez ici une collection de mes projets Python développés au sein du service commun d'électronique. +**Bienvenue dans ce référentiel !** Vous trouverez ici une collection de liens vers mes projets Python développés au sein du service commun d'électronique. + +- [Objectifs](#objectifs) +- [Structure](#structure) +- [Contribution](#contribution) +- [📄 Licence](#-licence) + +--- + +<br /> ## Objectifs * Exploration de projets Python par des retours d'expérience à travers une veille technologique +* Explication de ma méthodologie de travailler avec Python ## Structure -* Premier partage autour de la lecture des données de multimètres numériques de chez Keysight +* [Premier partage autour de la lecture des données de multimètres numériques de chez Keysight][link_multimeters_py] +* [Partage d'un scripts pour la recherche de valeurs de résistances pour un pont diviseur de tension][link_resistor_calculator_py] +* Prochainement, partage de scripts pour la communication avec des cartes d'acquisition de données ## Contribution @@ -18,12 +30,24 @@ N'hésitez pas à contribuer à ce référentiel en : * M'aider à améliorer la documentation existante * Faire remonter et proposer des corrections de bugs -## Licence +**Contact:** + +Vous pouvez me contacter par mail à l'adresse [arnauld.biganzoli[at]laplace.univ-tlse.fr](mailto:arnauld.biganzoli@laplace.univ-tlse.fr?subject=Contact%20projets%20Python%20du%20GitLab%20Koda%20du%20SCE) -Copyright (c) 2025 LAPLACE, UMR INP-UPS-CNRS N°5213 +## 📄 Licence Ce projet est sous licence [CeCILL-C](https://cecill.info/licences/Licence_CeCILL-C_V1-fr.html) -**Contact:** +image::https://img.shields.io/badge/License-CeCILL--C-blue.svg[link="https://cecill.info/licences/Licence_CeCILL-C_V1-fr.html", alt="License CeCILL-C", title="License CeCILL-C"] -Vous pouvez me contacter par mail à l'adresse [arnauld.biganzoli[at]laplace.univ-tlse.fr](mailto:arnauld.biganzoli@laplace.univ-tlse.fr?subject=Contact%20projets%20Python%20du%20GitLab%20Koda%20du%20SCE) + + +Copyright (c) 2025 LAPLACE, UMR INP-UPS-CNRS N°5213 + +--- + +<!-- Retrouvez ce projet sur le GitLab du service commun d'électronique : --> + +[link_multimeters_py]: https://src.koda.cnrs.fr/laplace-service-commun-electronique/membres/arnauld-biganzoli/python/visa-communication-with-digital-multimeters + +[link_resistor_calculator_py]: https://src.koda.cnrs.fr/laplace-service-commun-electronique/membres/arnauld-biganzoli/python/calculateur-de-resistances-pour-pont-diviseur-de-tension diff --git a/docs/methode-de-developpement-pour-python.md b/docs/methode-de-developpement-pour-python.md new file mode 100644 index 0000000000000000000000000000000000000000..0cf30a467dff034896bd2da64ba0916403ab51ec --- /dev/null +++ b/docs/methode-de-developpement-pour-python.md @@ -0,0 +1,73 @@ +<h2>Méthodologie de developpement en langage Python</h2> + +**Sommaire :** + +- [Installation de l'environnement Python](#installation-de-lenvironnement-python) +- [Installation d'un environnement virtuel pour chaque projet](#installation-dun-environnement-virtuel-pour-chaque-projet) +- [Activer votre environnement virtuel](#activer-votre-environnement-virtuel) +- [Installation des bibliothèques Python](#installation-des-bibliothèques-python) +- [Exécuter un programme Python](#exécuter-un-programme-python) + +--- + +<br /> + +## Installation de l'environnement Python + +Pour exécuter les scripts Python, vous devez disposer d'un environnement Python fonctionnel. + +La version de Python recommandée pour ces scripts est la version `3.12.5` + +Plusieurs options s'offrent à vous pour installer Python sur votre ordinateur : + +* Télécharger et installer Python depuis le site officiel [Python.org](https://www.python.org/downloads/). +* Passer par l'environnment [Anaconda](https://www.anaconda.com/products/distribution) qui est une distribution de Python qui inclut de nombreuses bibliothèques utiles dans le monde scientifique. +* Utiliser un gestionnaire des versions de Python, qui vous permettra de faire plusieurs installations de Python en parallèle. Voir [pyenv-win](https://github.com/pyenv-win/pyenv-win) qui est une version de pyenv pour Windows que j'utilise ici. + +## Installation d'un environnement virtuel pour chaque projet + +Pour chaque projet, je vous recommande de créer un environnement virtuel dédié. Cela vous permettra de gérer les dépendances de chaque projet de manière indépendante. + +Pour cela, vous pouvez utiliser le module `venv` de Python avec la version de Python que vous avez installée, est qui est compatible avec votre projet et les versions des bibliothèques que vous utiliserez. + +Pour créer un environnement virtuel, vous pouvez exécuter la commande suivante dans un terminal. + +Cette commande crée un dossier `.env` dans le répertoire courant qui contiendra l'environnement virtuel Python pour l'exécution de votre projet : + +```bash +python -m venv .env +``` + +## Activer votre environnement virtuel + +Placez vous dans le répertoire de votre projet, puis activez l'environnement virtuel que vous avez créé. + +Exécutez la commande suivante dans un terminal pour l'activer : + +```bash +`source .env/bin/activate` (sous Linux/macOS) ou `> .env\Scripts\activate` (sous Windows) +``` + +Une autre option est d'utiliser l'extension [Python pour Visual Studio Code](https://marketplace.visualstudio.com/items?itemName=ms-python.python), qui vous permet de sélectionner l'environnement virtuel à utiliser pour chaque projet. + +## Installation des bibliothèques Python + +Pour installer les bibliothèques nécessaires, vous pouvez utiliser le gestionnaire de paquets `pip`. + +Pour cela, soit vous installez les bibliothèques une par une, soit vous utilisez le fichier `requirements.txt` fourni dans le projet. + +Exécutez la commande suivante dans un terminal : + +```bash +pip install -r requirements.txt +``` + +## Exécuter un programme Python + +Vous êtes maintenant prêt à éxécuter un programme python depuis un terminal ou l'environnement de développement de votre choix. Ma recommandation est d'utiliser [Visual Studio Code](https://code.visualstudio.com/). + +Exemple d'exécution d'un programme Python depuis un terminal : + +```bash +(.env) > python src\example.py +``` diff --git a/images/logo-laplace.png b/images/logo-laplace.png new file mode 100644 index 0000000000000000000000000000000000000000..2da1ff5b44643d54af3337bd9aa79b07a83bb466 Binary files /dev/null and b/images/logo-laplace.png differ