Skip to content

Commit 35f2c1f

Browse files
PierreRaybautPierreRaybaut
committed
Doc: separate page on HDF5 browser
1 parent ebff98e commit 35f2c1f

File tree

5 files changed

+80
-115
lines changed

5 files changed

+80
-115
lines changed

‎doc/features/general/h5browser.rst‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
.. _h5browser:
2+
3+
HDF5 Browser
4+
============
5+
6+
.. meta::
7+
:description: HDF5 Browser in DataLab, the open-source scientific data analysis and visualization platform
8+
:keywords: DataLab, workspace, HDF5, browser, scientific, data, analysis, visualization, platform
9+
10+
The "HDF5 Browser" is a modal dialog box allowing to import almost any
11+
1D and 2D data into DataLab workspace (and eventually metadata).
12+
13+
.. image:: /images/h5browser.png
14+
15+
Compatible curve or image data are displayed in a hierarchical view
16+
on the left panel, as well as other scalar data (scalar values are just
17+
shown for context purpose and may not be imported into DataLab workspace).
18+
19+
The HDF5 browser is fairly simple to use:
20+
* On the left panel, select the curve or image data you want to import
21+
* Selected data is plotted on the right panel
22+
* Click on "Check all" if you want to import all compatible data
23+
* Then validate by clicking on "OK"

‎doc/features/general/workspace.rst‎

Lines changed: 2 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,8 @@ Workspace
44
=========
55

66
.. meta::
7-
:description: Workspace and HDF5 Browser in DataLab, the open-source scientific data analysis and visualization platform
8-
:keywords: DataLab, workspace, HDF5, browser, scientific, data, analysis, visualization, platform
9-
10-
Basic concepts
11-
--------------
7+
:description: Workspace in DataLab, the open-source scientific data analysis and visualization platform
8+
:keywords: DataLab, workspace, scientific, data, analysis, visualization, platform
129

1310
Working with DataLab is very easy. The user interface is intuitive and
1411
self-explanatory. The main window is divided into two main areas:
@@ -53,23 +50,3 @@ possible to import data sets from an HDF5 file into the workspace, using the
5350
such as `.txt` or `.npy` for 1D signals (see :ref:`open_signal` for the
5451
list of supported formats), , or `.tiff` or `.dcm` for 2D images
5552
(see :ref:`open_image` for the list of supported formats).
56-
57-
.. _h5browser:
58-
59-
HDF5 Browser
60-
------------
61-
62-
The "HDF5 Browser" is a modal dialog box allowing to import almost any
63-
1D and 2D data into DataLab workspace (and eventually metadata).
64-
65-
.. image:: /images/h5browser.png
66-
67-
Compatible curve or image data are displayed in a hierarchical view
68-
on the left panel, as well as other scalar data (scalar values are just
69-
shown for context purpose and may not be imported into DataLab workspace).
70-
71-
The HDF5 browser is fairly simple to use:
72-
* On the left panel, select the curve or image data you want to import
73-
* Selected data is plotted on the right panel
74-
* Click on "Check all" if you want to import all compatible data
75-
* Then validate by clicking on "OK"

‎doc/features/index.rst‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,7 @@ signal and image processing panels.
3333
:caption: General features:
3434

3535
general/workspace
36+
general/h5browser
3637
general/macros
3738
general/remote
3839
general/model

‎doc/locale/fr/LC_MESSAGES/features/general/h5browser.po‎

Lines changed: 37 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,10 @@
1-
# SOME DESCRIPTIVE TITLE.
2-
# Copyright (C) 2023, DataLab Platform Developers
3-
# This file is distributed under the same license as the DataLab package.
4-
# FIRST AUTHOR <EMAIL@ADDRESS>, 2024.
51
#
62
#, fuzzy
73
msgid ""
84
msgstr ""
95
"Project-Id-Version: DataLab \n"
106
"Report-Msgid-Bugs-To: \n"
11-
"POT-Creation-Date: 2023-12-29 15:46+0100\n"
7+
"POT-Creation-Date: 2024-03-04 18:06+0100\n"
128
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
139
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
1410
"Language: fr\n"
@@ -17,42 +13,65 @@ msgstr ""
1713
"MIME-Version: 1.0\n"
1814
"Content-Type: text/plain; charset=utf-8\n"
1915
"Content-Transfer-Encoding: 8bit\n"
20-
"Generated-By: Babel 2.14.0\n"
16+
"Generated-By: Babel 2.13.0\n"
17+
18+
#: ../../features/general/h5browser.rst:-1
19+
msgid ""
20+
"HDF5 Browser in DataLab, the open-source scientific data analysis and "
21+
"visualization platform"
22+
msgstr "Explorateur HDF5 dans DataLab, la plateforme open-source d'analyse et de visualisation de données scientifiques"
23+
24+
#: ../../features/general/h5browser.rst:-1
25+
msgid ""
26+
"DataLab, workspace, HDF5, browser, scientific, data, analysis, "
27+
"visualization, platform"
28+
msgstr "DataLab, espace de travail, HDF5, explorateur, scientifique, données, analyse, visualisation, plateforme"
2129

2230
#: ../../features/general/h5browser.rst:4
2331
msgid "HDF5 Browser"
24-
msgstr ""
32+
msgstr "Explorateur HDF5"
2533

26-
#: ../../features/general/h5browser.rst:6
34+
#: ../../features/general/h5browser.rst:10
2735
msgid ""
2836
"The \"HDF5 Browser\" is a modal dialog box allowing to import almost any "
2937
"1D and 2D data into DataLab workspace (and eventually metadata)."
3038
msgstr ""
39+
"L'explorateur HDF5 est une boîte de dialogue modale permettant d'importer"
40+
" presque n'importe quelles données à 1 ou 2 dimensions dans l'espace de "
41+
"travail de DataLab. Dans certains cas, des métadonnées sont également "
42+
"importées."
3143

32-
#: ../../features/general/h5browser.rst:11
44+
#: ../../features/general/h5browser.rst:15
3345
msgid ""
3446
"Compatible curve or image data are displayed in a hierarchical view on "
3547
"the left panel, as well as other scalar data (scalar values are just "
3648
"shown for context purpose and may not be imported into DataLab "
3749
"workspace)."
3850
msgstr ""
51+
"Les données de type courbe ou image sont affichées sous la forme d'une "
52+
"vue hiérarchique dans le panneau de gauche, de même que les données "
53+
"scalaires (les valeurs scalaires sont simplement affichées à titre "
54+
"d'informations contextuelles et ne peuvent pas être importées dans "
55+
"l'espace de travail de DataLab)."
3956

40-
#: ../../features/general/h5browser.rst:18
57+
#: ../../features/general/h5browser.rst:22
4158
msgid "The HDF5 browser is fairly simple to use:"
42-
msgstr ""
59+
msgstr "L'explorateur de fichiers HDF5 est très simple à utiliser :"
4360

44-
#: ../../features/general/h5browser.rst:16
61+
#: ../../features/general/h5browser.rst:20
4562
msgid "On the left panel, select the curve or image data you want to import"
46-
msgstr ""
63+
msgstr "Dans le panneau de gauche, sélectionner la courbe ou l'image à importer"
4764

48-
#: ../../features/general/h5browser.rst:17
65+
#: ../../features/general/h5browser.rst:21
4966
msgid "Selected data is plotted on the right panel"
5067
msgstr ""
68+
"Les données sélectionnées peuvent être visualisées graphiquement dans le "
69+
"panneau de droite"
5170

52-
#: ../../features/general/h5browser.rst:18
71+
#: ../../features/general/h5browser.rst:22
5372
msgid "Click on \"Check all\" if you want to import all compatible data"
54-
msgstr ""
73+
msgstr "Cliquer sur \"Cocher tout\" pour importer toutes les données compatibles"
5574

56-
#: ../../features/general/h5browser.rst:19
75+
#: ../../features/general/h5browser.rst:23
5776
msgid "Then validate by clicking on \"OK\""
58-
msgstr ""
77+
msgstr "Valider ensuite en cliquant sur \"OK\""

‎doc/locale/fr/LC_MESSAGES/features/general/workspace.po‎

Lines changed: 17 additions & 72 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ msgid ""
88
msgstr ""
99
"Project-Id-Version: DataLab \n"
1010
"Report-Msgid-Bugs-To: \n"
11-
"POT-Creation-Date: 2024-02-16 14:01+0100\n"
11+
"POT-Creation-Date: 2024-03-04 18:06+0100\n"
1212
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
1313
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
1414
"Language-Team: LANGUAGE <LL@li.org>\n"
@@ -19,25 +19,22 @@ msgstr ""
1919

2020
#: ../../features/general/workspace.rst:-1
2121
msgid ""
22-
"Workspace and HDF5 Browser in DataLab, the open-source scientific data "
23-
"analysis and visualization platform"
24-
msgstr "Esapce de travail et explorateur HDF5 dans DataLab, la plateforme open-source d'analyse et de visualisation de données scientifiques"
22+
"Workspace in DataLab, the open-source scientific data analysis and "
23+
"visualization platform"
24+
msgstr ""
25+
"Espace de travail dans DataLab, la plateforme open-"
26+
"source d'analyse et de visualisation de données scientifiques"
2527

2628
#: ../../features/general/workspace.rst:-1
27-
msgid ""
28-
"DataLab, workspace, HDF5, browser, scientific, data, analysis, "
29-
"visualization, platform"
30-
msgstr "DataLab, espace de travail, HDF5, explorateur, scientifique, données, analyse, visualisation, plateforme"
29+
msgid "DataLab, workspace, scientific, data, analysis, visualization, platform"
30+
msgstr ""
31+
"DataLab, espace de travail, scientifique, données, analyse, visualisation, plateforme"
3132

3233
#: ../../features/general/workspace.rst:4
3334
msgid "Workspace"
3435
msgstr "Espace de travail"
3536

36-
#: ../../features/general/workspace.rst:11
37-
msgid "Basic concepts"
38-
msgstr "Concepts de base"
39-
40-
#: ../../features/general/workspace.rst:13
37+
#: ../../features/general/workspace.rst:10
4138
msgid ""
4239
"Working with DataLab is very easy. The user interface is intuitive and "
4340
"self-explanatory. The main window is divided into two main areas:"
@@ -46,7 +43,7 @@ msgstr ""
4643
"appréhendable facilement. La fenêtre principale est divisée en deux zones"
4744
" principales :"
4845

49-
#: ../../features/general/workspace.rst:16
46+
#: ../../features/general/workspace.rst:13
5047
msgid ""
5148
"The right area shows the list of data sets which are currently loaded in "
5249
"DataLab, distibuted over two tabs: **Signals** and **Images**. The user "
@@ -63,7 +60,7 @@ msgstr ""
6360
"barre d'outils. Sous la liste des jeux de données, une vue **Propriétés**"
6461
" affiche des informations sur le jeu de données actuellement sélectionné."
6562

66-
#: ../../features/general/workspace.rst:23
63+
#: ../../features/general/workspace.rst:20
6764
msgid ""
6865
"The left area shows the visualization of the currently selected data set."
6966
" The visualization is updated automatically when the user selects a new "
@@ -74,11 +71,11 @@ msgstr ""
7471
"l'utilisateur sélectionne un nouveau jeu de données dans la liste des "
7572
"jeux de données."
7673

77-
#: ../../features/general/workspace.rst:29
74+
#: ../../features/general/workspace.rst:26
7875
msgid "DataLab main window, at startup."
7976
msgstr "Fenêtre principale de DataLab, au démarrage."
8077

81-
#: ../../features/general/workspace.rst:31
78+
#: ../../features/general/workspace.rst:28
8279
msgid ""
8380
"DataLab has its own internal data model, in which data sets are organized"
8481
" around a tree structure. Each panel in the main window corresponds to a "
@@ -96,7 +93,7 @@ msgstr ""
9693
"Le modèle de données est décrit plus en détail dans la section API (voir "
9794
":mod:`cdl.obj`)."
9895

99-
#: ../../features/general/workspace.rst:38
96+
#: ../../features/general/workspace.rst:35
10097
msgid ""
10198
"For each data set (1D signal or 2D image), not only the data itself is "
10299
"stored, but also a set of metadata, which describes the data or the way "
@@ -112,7 +109,7 @@ msgstr ""
112109
"via l'attribut ``metadata`` du jeu de données (et peuvent également être "
113110
"parcourues dans la vue **Propriétés**, avec le bouton **Métadonnées**)."
114111

115-
#: ../../features/general/workspace.rst:44
112+
#: ../../features/general/workspace.rst:41
116113
msgid ""
117114
"The DataLab **Workspace** is defined as the collection of all data sets "
118115
"which are currently loaded in DataLab, in both the **Signals** and "
@@ -127,7 +124,7 @@ msgstr ""
127124
"également possible d'importer des jeux de données à partir d'un fichier "
128125
"HDF5 dans l'espace de travail, en utilisant l':ref:`h5browser`."
129126

130-
#: ../../features/general/workspace.rst:52
127+
#: ../../features/general/workspace.rst:49
131128
msgid ""
132129
"Data sets may also be saved or loaded individually, using data formats "
133130
"such as `.txt` or `.npy` for 1D signals (see :ref:`open_signal` for the "
@@ -139,55 +136,3 @@ msgstr ""
139136
"`.npy` pour les signaux 1D (voir :ref:`open_signal` pour la liste des "
140137
"formats pris en charge), ou `.tiff` ou `.dcm` pour les images 2D (voir "
141138
":ref:`open_image` pour la liste des formats pris en charge)."
142-
143-
#: ../../features/general/workspace.rst:60
144-
msgid "HDF5 Browser"
145-
msgstr "Explorateur HDF5"
146-
147-
#: ../../features/general/workspace.rst:62
148-
msgid ""
149-
"The \"HDF5 Browser\" is a modal dialog box allowing to import almost any "
150-
"1D and 2D data into DataLab workspace (and eventually metadata)."
151-
msgstr ""
152-
"L'explorateur HDF5 est une boîte de dialogue modale permettant d'importer"
153-
" presque n'importe quelles données à 1 ou 2 dimensions dans l'espace de "
154-
"travail de DataLab. Dans certains cas, des métadonnées sont également "
155-
"importées."
156-
157-
#: ../../features/general/workspace.rst:67
158-
msgid ""
159-
"Compatible curve or image data are displayed in a hierarchical view on "
160-
"the left panel, as well as other scalar data (scalar values are just "
161-
"shown for context purpose and may not be imported into DataLab "
162-
"workspace)."
163-
msgstr ""
164-
"Les données de type courbe ou image sont affichées sous la forme d'une "
165-
"vue hiérarchique dans le panneau de gauche, de même que les données "
166-
"scalaires (les valeurs scalaires sont simplement affichées à titre "
167-
"d'informations contextuelles et ne peuvent pas être importées dans "
168-
"l'espace de travail de DataLab)."
169-
170-
#: ../../features/general/workspace.rst:74
171-
msgid "The HDF5 browser is fairly simple to use:"
172-
msgstr "L'explorateur de fichiers HDF5 est très simple à utiliser :"
173-
174-
#: ../../features/general/workspace.rst:72
175-
msgid "On the left panel, select the curve or image data you want to import"
176-
msgstr "Dans le panneau de gauche, sélectionner la courbe ou l'image à importer"
177-
178-
#: ../../features/general/workspace.rst:73
179-
msgid "Selected data is plotted on the right panel"
180-
msgstr ""
181-
"Les données sélectionnées peuvent être visualisées graphiquement dans le "
182-
"panneau de droite"
183-
184-
#: ../../features/general/workspace.rst:74
185-
msgid "Click on \"Check all\" if you want to import all compatible data"
186-
msgstr "Cliquer sur \"Cocher tout\" pour importer toutes les données compatibles"
187-
188-
#: ../../features/general/workspace.rst:75
189-
msgid "Then validate by clicking on \"OK\""
190-
msgstr "Valider ensuite en cliquant sur \"OK\""
191-
192-
#~ msgid "It is fairly simple to use:"
193-
#~ msgstr ""

0 commit comments

Comments
 (0)