1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
|
Setting up Development Environment
==================================
Getting started with DataLab development is easy.
Here is what you will need:
1. An integrated development environment (IDE) for Python. We recommend
[Spyder](https://www.spyder-ide.org/) or [Visual Studio Code](https://code.visualstudio.com/),
but any IDE will do.
2. A Python distribution. We recommend [WinPython](https://winpython.github.io/),
on Windows, or [Anaconda](https://www.anaconda.com/), on Linux or Mac.
But, again, any Python distribution will do.
3. A clean project structure (see below).
4. Test data (see below).
5. Environment variables (see below).
6. Third-party software (see below).
Development Environment
-----------------------
If you are using [Spyder](https://www.spyder-ide.org/), thank you for supporting
the scientific open-source Python community!
If you are using Visual Studio Code, that's also an excellent choice (for other
reasons). We recommend installing the following extensions:
| Extension | Description |
| --------- | ----------- |
| [gettext](https://marketplace.visualstudio.com/items?itemName=mrorz.language-gettext) | Gettext syntax highlighting |
| [Pylance](https://marketplace.visualstudio.com/items?itemName=ms-python.vscode-pylance) | Python language server |
| [Python](https://marketplace.visualstudio.com/items?itemName=ms-python.python) | Python extension |
| [reStructuredText Syntax highlighting](https://marketplace.visualstudio.com/items?itemName=trond-snekvik.simple-rst) | reStructuredText syntax highlighting |
| [Ruff](https://marketplace.visualstudio.com/items?itemName=charliermarsh.ruff) | Extremely fast Python linter and code formatter |
| [Todo Tree](https://marketplace.visualstudio.com/items?itemName=Gruntfuggly.todo-tree) | Todo tree |
| [Insert GUID](https://marketplace.visualstudio.com/items?itemName=heaths.vscode-guid) | Insert GUID |
| [XML Tools](https://marketplace.visualstudio.com/items?itemName=DotJoshJohnson.xml) | XML Tools |
Python Environment
------------------
DataLab requires the following :
* Python (e.g. WinPython)
* Additional Python packages
Installing all required packages :
pip install --upgrade -r requirements.txt
ℹ️ See [Installation](https://datalab-platform.com/en/intro/installation.html)
for more details on reference Python and Qt versions.
⚠️ If you are contributing to DataLab's processing features, you will need to work on both DataLab's main repository and sigima's repository. To install `sigima` in editable mode, use the following command:
pip install -e ../sigima # Adjust the path to your local sigima repository
If you are using [WinPython](https://winpython.github.io/), thank you for supporting
the scientific open-source Python community!
The following table lists the currently officially used Python distributions:
| Python version | Status | WinPython version |
| -------------- | ------------ | ----------------- |
| 3.9 | OK | 3.9.10.0 |
| 3.10 | OK | 3.10.11.1 |
| 3.11 | OK | 3.11.5.0 |
| 3.12 | OK | 3.12.3.0 |
| 3.13 | OK | 3.13.2.0 |
⚠ We strongly recommend using the `.dot` versions of WinPython which are lightweight
and can be customized to your needs (using `pip install -r requirements.txt`).
✅ We also recommend using a dedicated WinPython instance for DataLab.
Test data
---------
DataLab test data are located in different folders, depending on their nature or origin.
Required data for unit tests are located in "datalab\data\tests" (public data).
A second folder %DATALAB_DATA% (optional) may be defined for additional tests which are
still under development (or for confidential data).
Specific environment variables
------------------------------
Enable the "debug" mode (no stdin/stdout redirection towards internal console):
@REM Mode DEBUG
set DEBUG=1
Building PDF documentation requires LaTeX. On Windows, the following environment:
@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%
Visual Studio Code configuration used in `launch.json` and/or `tasks.json`
(examples) :
@REM Folder containing additional working test data
set DATALAB_DATA=C:\Dev\Projets\DATALAB_data
Visual Studio Code `.env` file:
* This file is used to set environment variables for the application.
* It is used to set the `PYTHONPATH` environment variable to the root of the project.
* This is required to be able to import the project modules from within VS Code.
* To create this file, copy the `.env.template` file to `.env`
(and eventually add your own paths).
Windows installer
-----------------
The Windows installer is built using [WiX Toolset](https://wixtoolset.org/) V4.0.5.
Using the WiX Toolset requires [.NET SDK](https://dotnet.microsoft.com/download/dotnet/) 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
Third-party Software
--------------------
The following software may be required for maintaining the project:
| Software | Description |
| -------- | ----------- |
| [gettext](https://mlocati.github.io/articles/gettext-iconv-windows.html) | Translations |
| [Git](https://git-scm.com/) | Version control system |
| [ImageMagick](https://imagemagick.org/) | Image manipulation utilities |
| [Inkscape](https://inkscape.org/) | Vector graphics editor |
| [MikTeX](https://miktex.org/) | LaTeX distribution on Windows |
|
