Mise en place de l’environnement de développement#

Environnement de développement#

Si vous utilisez Spyder, merci de soutenir la communauté scientifique Python open-source !

Si vous utilisez Visual Studio Code, c’est aussi un excellent choix (pour d’autres raisons). Nous recommandons d’installer les extensions suivantes :

Environnement Python#

DataLab nécessite les éléments suivants :

• Python (p.ex. WinPython)

• Paquets Python supplémentaires

Installation de tous les paquets requis :

pip install --upgrade -r dev\requirements.txt

Voir Installation pour plus de détails sur les versions de référence de Python et Qt.

Si vous utilisez WinPython, merci de soutenir la communauté scientifique Python open-source !

Le tableau suivant liste les distributions Python actuellement utilisées officiellement :

⚠ Nous recommandons fortement d’utiliser les versions .dot de WinPython qui sont légères et peuvent être personnalisées selon vos besoins (en utilisant pip install -r requirements.txt).

✅ Nous recommandons également d’utiliser une instance WinPython dédiée pour DataLab.

Données de test#

Les données de test de DataLab sont situées dans différents dossiers, selon leur nature ou leur origine.

Les données requises pour les tests unitaires sont situées dans « cdl\data\tests » (données publiques)

Un second dossier %CDL_DATA% (facultatif) peut être défini pour des tests supplémentaires qui sont encore en cours de développement (ou pour des données confidentielles).

Variables d’environnement spécifiques#

Activer le mode « debug » (pas de redirection stdin/stdout vers la console interne) :

@REM Mode DEBUG
set DEBUG=1

Générer la documentation PDF nécessite LaTeX. Sur Windows, l’environnement suivant :

@REM LaTeX executable must be in Windows PATH, for mathematical equations rendering
@REM Example with MiKTeX :
set PATH=C:\\Apps\\miktex-portable\\texmfs\\install\\miktex\\bin\\x64;%PATH%

La configuration de Visual Studio Code utilisée dans launch.json et tasks.json (exemples) :

@REM Development environment
set CDL_PYTHONEXE=C:\python-3.9.10.amd64\python.exe
@REM Folder containing additional working test data
set CDL_DATA=C:\Dev\Projets\CDL_data

Fichier .env de Visual Studio Code :

• Ce fichier est utilisé pour définir les variables d’environnement de l’application.

• Il est utilisé pour définir la variable d’environnement PYTHONPATH à la racine du projet.

• Cela est nécessaire pour pouvoir importer les modules du projet depuis VS Code.

• Pour créer ce fichier, copiez le fichier .env.template en .env (et ajoutez éventuellement vos propres chemins).

Windows installer#

The Windows installer is built using WiX Toolset V4.0.5. Using the WiX Toolset requires .NET SDK V6.0 minimum.

You may install .NET SDK using winget:

winget install Microsoft.DotNet.SDK.8

Once .NET SDK is installed, the WiX Toolset can be installed and configured using the following commands:

dotnet tool install --global wix --version 4.0.5
wix extension add WixToolset.UI.wixext/4.0.5

First, you need to generate the installer script from a generic template:

python wix/makewxs.py

Building the installer is done using the following command:

wix build .\wix\DataLab.wxs -ext WixToolset.UI.wixext

Logiciels tiers#

Les logiciels suivants peuvent être nécessaires pour maintenir le projet :