Guide de l’utilisateur de PALM Tracer

Installation

Ce guide vous aidera à installer le projet étape par étape.

Étape 1 : Téléchargement depuis GitHub

  1. Rendez-vous sur la page GitHub du projet.

  2. Cliquez sur Code (le bouton vert).

  3. Choisissez Download ZIP pour télécharger les fichiers du projet sur votre ordinateur.

  4. Extrayez les fichiers dans un dossier accessible (par exemple, C:\palm-tracer).

Étape 2 : Installation de Python et des éléments additionnels

Vous pouvez utiliser chocolatey pour gérer vos différents programmes et installation (nécessite des droits administrateur)

Set-ExecutionPolicy Bypass -Scope Process -Force; [System.Net.ServicePointManager]::SecurityProtocol = [System.Net.ServicePointManager]::SecurityProtocol -bor 3072; iex ((New-Object System.Net.WebClient).DownloadString('https://community.chocolatey.org/install.ps1'))

choco install python -y
choco install visualstudio2022buildtools --includeRecommended -y
choco install vcredist-all -y`

Sinon, vous pouvez tout faire manuellement :

  1. Téléchargez Python depuis le site officiel.

  2. Pendant l’installation, assurez-vous de cocher l’option Add Python to PATH.

  3. Une fois installé, vérifiez que Python fonctionne :

    • Ouvrez un terminal ou une invite de commande (PowerShell sur Windows).

    • Tapez la commande suivante python --version et appuyez sur Entrée

Note

Vous devriez voir une version de Python (par exemple, Python 3.x.x).

  1. Les différentes bibliothèques nécessitent parfois des éléments additionnels pour fonctionner :

  • Build Tools for Visual Studio. Pendant l’installation, assurez-vous de cocher C++ build tools

  • vcredist : celui-ci sera installé avec Build Tools for Visual Studio.

Étape 3 : Création d’un environnement virtuel (optionnel)

Un environnement virtuel permet de gérer les dépendances du projet de manière isolée.

  1. Ouvrez un terminal ou une invite de commande (PowerShell sur Windows) dans le dossier où vous avez extrait les fichiers du projet. Exemple pour C:\palm-tracer. Ouvrez le terminal et tapez la commande suivante cd C:\palm_tracer et appuyez sur Entrée

  2. Créez un environnement virtuel avec la commande suivante python -m venv venv

  3. Activez l’environnement virtuel :

    • Sous Windows : .\venv\Scripts\activate

    • Sous macOS/Linux : source venv/bin/activate

  4. Vous verrez maintenant (venv) au début de votre invite de commande, indiquant que l’environnement virtuel est actif.

Étape 4 : Installation du plugin

  1. Ouvrez un terminal ou une invite de commande (PowerShell sur Windows) dans le dossier où vous avez extrait les fichiers du projet. Exemple pour C:\palm-tracer. Ouvrez le terminal et tapez la commande suivante cd C:\palm_tracer et appuyez sur Entrée

  2. Assurez-vous que l’environnement virtuel est activé si vous le souhaitez (voir Étape 3).

  3. Installez les dépendances nécessaires avec la commande :

$env:SETUPTOOLS_SCM_PRETEND_VERSION_FOR_PALM_TRACER = "1.0.0"
python -m pip install .[testing,documentation]`

Note

La première ligne est necessaire, si vous avez téléchargé le zip du code source à partir de Git. Si vous avez cloné le dépôt, cela n’est plus necessaire. Les éléments supplémentaires tels que testing installent Napari entre autres éléments si vous ne l’aviez pas déjà.

Étape 5 : Lancement du plugin

  1. Ouvrez un terminal ou une invite de commande (PowerShell sur Windows) dans le dossier où vous avez extrait les fichiers du projet. Exemple pour C:\palm-tracer. Ouvrez le terminal et tapez la commande suivante cd C:\palm_tracer et appuyez sur Entrée

  2. Assurez-vous que l’environnement virtuel est activé si vous le souhaitez (voir Étape 3).

  3. Lancez Napari avec la commande : napari

Note

Si vous n’avez pas créé d’environnement virtuel, Napari peut être lancé depuis n’importe où.

  1. Activez le plugin dans Napari : Plugins ‣ PALM Tracer

Étape 6 : Supprimer la mise à l’échelle de Napari

Napari utilise QT et celui-ci est paramétré sur la mise à l’échelle automatique de Windows qui permet, notamment, d’agrandir l’interface sur les petits écrans ayant une résolution élevée. Cela peut devenir parfois gênant, il est possible de modifier ce comportement.

  1. Ouvrez un terminal ou une invite de commande (PowerShell sur Windows).

  2. Lancez la commande $env:QT_AUTO_SCREEN_SCALE_FACTOR="0" dans PowerShell sous Windows ou export QT_AUTO_SCREEN_SCALE_FACTOR=0 sous Linux et macOS.

  3. Pour réactiver la mise à l’échelle, lancez la commande : Remove-Item Env:\QT_AUTO_SCREEN_SCALE_FACTOR dans PowerShell sous Windows ou unset QT_AUTO_SCREEN_SCALE_FACTOR sous Linux et macOS.

C’est terminé ! 🎉 Vous avez installé et configuré le plugin avec succès.

Utilisation

FAQ

1. Pourquoi utiliser un environnement virtuel ? Pour éviter les conflits entre les dépendances de différents projets. Ou nécessaire lorsque vous n’avez pas les droits administrateur sur votre système.

2. Et si je n’ai pas `pip install` ? Cela signifie que Python n’est pas bien installé. Reprenez l’Étape 2 et assurez-vous d’avoir ajouté Python au PATH.

3. Pourquoi, certaines commandes me mettent une erreur pour me dire que je n’ai pas les autorisations nécessaires ? Certaines commandes nécessitent des droits administrateur. Il faut lancer le terminal en mode administrateur sous Windows.

4. Où puis-je trouver plus d’aide ? Consultez la documentation officielle de Python ou contactez le support du projet.