diff --git a/backend/README.md b/backend/README.md index 8e02f07d..96c1550b 100644 --- a/backend/README.md +++ b/backend/README.md @@ -37,7 +37,7 @@ pip install -e . # editable mode allows changes to have instant impact ## Documentation build ```commandline . venv/bin/activate -pip install -U sphinx sphinx-autosummary-accessors sphinx_immaterial +pip install sphinx==8.2.3 sphinx-autosummary-accessors==2025.3.1 sphinx_immaterial==0.13.9 make -C docs html ``` diff --git a/docs/source/developers_manual/frontend_development/commands.rst b/docs/source/developers_manual/frontend_development/commands.rst index 5785baf9..55f97cf6 100644 --- a/docs/source/developers_manual/frontend_development/commands.rst +++ b/docs/source/developers_manual/frontend_development/commands.rst @@ -61,7 +61,7 @@ Install sphinx dependencies to be able to build the documentation: .. code-block:: bash . ibex_venv/bin/activate - pip install -U sphinx sphinx-autosummary-accessors sphinx_immaterial + pip install sphinx==8.2.3 sphinx-autosummary-accessors==2025.3.1 sphinx_immaterial==0.13.9 **Build the documentation** diff --git a/docs/source/users_manual/features/configuration_file.rst b/docs/source/users_manual/features/configuration_file.rst index 3bcc9e81..16583050 100644 --- a/docs/source/users_manual/features/configuration_file.rst +++ b/docs/source/users_manual/features/configuration_file.rst @@ -6,7 +6,7 @@ When you save a configuration, a file in the following format will be created. I You can share configuration files with other users to quickly access their workspace. -You can also edit the file manually before loading it. However, this is dangerous and should only be done with caution by experienced users, as incorrect edits could cause unwanted bugs in the configuration. +You can also edit the file manually before loading it. However, this is not recommended and dangerous. It should only be done with caution by experienced users, as incorrect edits could cause unwanted bugs in the configuration. Exemple configuration file : @@ -27,6 +27,11 @@ Exemple configuration file : "title": "t_e_URI-0", "isTitleOverwritten": false, "displayErrorBand": false, + "synchronizedGrids": { + "color": "", + "list": [] + }, + "interpolated_method": "exact_value", "xAxisData": { "name": "time", "unit": "s", @@ -43,11 +48,13 @@ Exemple configuration file : "h": 12, "coordinates": [ { + "axeIndex": 0, "path": "#ece/time", "target": "#ece/channel[0]/t_e/data[0]", "valueIndex": 0 }, { + "axeIndex": 1, "path": "", "target": "#ece/channel[0]", "valueIndex": 0 @@ -57,7 +64,12 @@ Exemple configuration file : { "nodeUri": "URI-0#ece:0/channel[0]/t_e/data", "yaxis": "", - "labelUri": "URI-0" + "labelUri": "URI-0", + "line": { + "color": "rgb(31, 119, 180)" + }, + "customPreferences": {}, + "mode": "line" } ] } diff --git a/docs/source/users_manual/features/customization.rst b/docs/source/users_manual/features/customization.rst index e4c4c4e8..b63d7e1c 100644 --- a/docs/source/users_manual/features/customization.rst +++ b/docs/source/users_manual/features/customization.rst @@ -5,69 +5,102 @@ Customization Overview -------------------- -Here is the customization component: +The customization component is divided into sections accessible on the right. -.. image:: images/customization_main.png - :alt: Customization component +It is used for data manipulation as well as visual customization. Depending on the type of customization you choose, the corresponding features will be displayed. + +Here is the data manipulation: + +.. image:: images/customization_data_main.png + :alt: Data manipulation component :align: center -The customization is divided into sections accessible on the right. +And here is the visual customization: + +.. image:: images/customization_visual_main.png + :alt: Visual customization component + :align: center When you make changes, you can see the updates reflected in the graph on the left. You can undo changes by clicking the button with the red X in the upper-left corner. Otherwise, simply click the button with the orange checkmark to apply the customization. +Data manipulation +-------------------- + +Downsampling +~~~~~~~~~~~~~~~~~~~~~~~~ + +Applies a downsampling method to reduce the data size while preserving its original appearance: + +.. image:: images/customization_downsampling.png + :alt: Downsampling section of the data manipulation + :align: center + +Interpolation +~~~~~~~~~~~~~~~~~~~~~~~~ + +Applies an interpolation method to fill gaps between data points by estimating intermediate values: + +.. image:: images/customization_interpolation.png + :alt: Interpolation section of the data manipulation + :align: center + + +Visual customization +---------------------------- Global --------------------- +~~~~~~~~~~~~ Allows you to modify general parameters of a graph: .. image:: images/customization_global.png - :alt: Global section of the customization + :alt: Global section of the visual customization :align: center 1D plots --------------------- +~~~~~~~~~~~~ Allows you to customize the appearance of 1D plots: .. image:: images/customization_1d_plot.png - :alt: 1D plots section of the customization + :alt: 1D plots section of the visual customization :align: center Heatmap --------------------- +~~~~~~~~~~~~ Allows you to modify the color scale of the heatmap: .. image:: images/customization_heatmap.png - :alt: Heatmap section of the customization + :alt: Heatmap section of the visual customization :align: center -Axis range --------------------- +Geometry +~~~~~~~~~~~~ -Allows you to trim data for a more detailed visualization: +Allows you to overlay geometries: -.. image:: images/customization_axis_range.png - :alt: Axis range section of the customization +.. image:: images/customization_geometry.png + :alt: Geometry section of the visual customization :align: center -Downsampling --------------------- -Applies a downsampling method to reduce the data size while preserving its original appearance: +Axis range +~~~~~~~~~~~~ -.. image:: images/customization_downsampling.png - :alt: Downsampling section of the customization +Allows you to trim data for a more detailed visualization: + +.. image:: images/customization_axis_range.png + :alt: Axis range section of the visual customization :align: center Dataplot synchronization ---------------------------------- +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Allows you to link plots by their coordinates to facilitate comparison when using sliders: .. image:: images/customization_synchronization.png - :alt: Synchronization section of the customization + :alt: Synchronization section of the visual customization :align: center diff --git a/docs/source/users_manual/features/draggable_component.rst b/docs/source/users_manual/features/draggable_component.rst index 970a473e..7f4e4466 100644 --- a/docs/source/users_manual/features/draggable_component.rst +++ b/docs/source/users_manual/features/draggable_component.rst @@ -19,10 +19,6 @@ Each chart includes several options: :alt: Plot data with slider :align: center -**Downsampling method:** - -Selecting the downsampling method reduces the amount of data to be displayed while preserving the visual appearance of the data. - **Error bands:** Enabling or disabling error bars allows you to load the "_error_upper" & "_error_lower" data to represent them as vertical lines. @@ -35,9 +31,13 @@ Allows you to select how you want the data to be displayed. In 1D, it will be re This opens a ":doc:`Metadata `" component that displays various information related to all nodes (path, min, max, average, value, coordinates, etc.). This gives the user a broader overview of the data. -**Customize the grid:** +**Data manipulation:** + +It opens a ":doc:`Customization `" component which allows to personnalize the grid. It includes data manipulation features. + +**Visual customization:** -It opens a ":doc:`Customization `" component which allows to personnalize the grid. +It opens a ":doc:`Customization `" component which allows to personnalize the grid. It includes visual customization features. **Edit Grid:** diff --git a/docs/source/users_manual/features/images/customization_data_main.png b/docs/source/users_manual/features/images/customization_data_main.png new file mode 100644 index 00000000..d6209241 Binary files /dev/null and b/docs/source/users_manual/features/images/customization_data_main.png differ diff --git a/docs/source/users_manual/features/images/customization_geometry.png b/docs/source/users_manual/features/images/customization_geometry.png new file mode 100644 index 00000000..a309e2db Binary files /dev/null and b/docs/source/users_manual/features/images/customization_geometry.png differ diff --git a/docs/source/users_manual/features/images/customization_global.png b/docs/source/users_manual/features/images/customization_global.png index 3219481b..9dc223a8 100644 Binary files a/docs/source/users_manual/features/images/customization_global.png and b/docs/source/users_manual/features/images/customization_global.png differ diff --git a/docs/source/users_manual/features/images/customization_interpolation.png b/docs/source/users_manual/features/images/customization_interpolation.png new file mode 100644 index 00000000..1da5cefd Binary files /dev/null and b/docs/source/users_manual/features/images/customization_interpolation.png differ diff --git a/docs/source/users_manual/features/images/customization_main.png b/docs/source/users_manual/features/images/customization_main.png deleted file mode 100644 index 28fb6194..00000000 Binary files a/docs/source/users_manual/features/images/customization_main.png and /dev/null differ diff --git a/docs/source/users_manual/features/images/customization_visual_main.png b/docs/source/users_manual/features/images/customization_visual_main.png new file mode 100644 index 00000000..5b557e99 Binary files /dev/null and b/docs/source/users_manual/features/images/customization_visual_main.png differ diff --git a/docs/source/users_manual/features/images/plot_data.png b/docs/source/users_manual/features/images/plot_data.png index 7c11ceb7..42fabbee 100644 Binary files a/docs/source/users_manual/features/images/plot_data.png and b/docs/source/users_manual/features/images/plot_data.png differ diff --git a/docs/source/users_manual/features/images/plot_data_heatmap.png b/docs/source/users_manual/features/images/plot_data_heatmap.png index 51a59948..4cc0d8f6 100644 Binary files a/docs/source/users_manual/features/images/plot_data_heatmap.png and b/docs/source/users_manual/features/images/plot_data_heatmap.png differ diff --git a/docs/source/users_manual/features/images/plot_data_slider.png b/docs/source/users_manual/features/images/plot_data_slider.png index 64771d74..bccda17d 100644 Binary files a/docs/source/users_manual/features/images/plot_data_slider.png and b/docs/source/users_manual/features/images/plot_data_slider.png differ diff --git a/docs/source/users_manual/features/images/plot_data_with_error_bands.png b/docs/source/users_manual/features/images/plot_data_with_error_bands.png index e5a58207..be8ed87e 100644 Binary files a/docs/source/users_manual/features/images/plot_data_with_error_bands.png and b/docs/source/users_manual/features/images/plot_data_with_error_bands.png differ diff --git a/docs/source/users_manual/features/plot_data.rst b/docs/source/users_manual/features/plot_data.rst index 169f805a..2d3e4b5e 100644 --- a/docs/source/users_manual/features/plot_data.rst +++ b/docs/source/users_manual/features/plot_data.rst @@ -6,7 +6,7 @@ Plot data To plot a data point on a chart, simply click on the corresponding node in the tree. Each node is preceded by a checkbox : you can either click the checkbox or directly click the node name. This will create a component in the draggable area on the right. -You can plot 1D / heatmap charts with one or multiple nodes, as long as they share the same X-axis. Up to two different Y-axes can be displayed simultaneously. +You can plot 1D / heatmap / contour charts with one or multiple nodes, as long as they share the same X-axis. Up to two different Y-axes can be displayed simultaneously. .. image:: images/plot_data.png :alt: Plot simple data @@ -20,7 +20,7 @@ Some data has dependencies represented as sliders. It is possible to explore the By default, the chart title is generated using the node's name, unit, and associated URI. The Y-axes are labelled with the name of the first plotted plot and their unit. Finally, the X-axis is labeled with the name used to retrieve coordinates and his unit. Each data series is distinguished by a default color. -We can switch to the 1D / heatmap display by clicking on the corresponding button. +We can switch to the 1D / heatmap / Contour display by clicking on the corresponding button. .. image:: images/plot_data_heatmap.png :alt: Heatmap plot data with diff --git a/docs/source/users_manual/features/tree.rst b/docs/source/users_manual/features/tree.rst index 9f7b6c45..9b8fc57e 100644 --- a/docs/source/users_manual/features/tree.rst +++ b/docs/source/users_manual/features/tree.rst @@ -8,7 +8,7 @@ After selecting your URIs, you can navigate through the hierarchy to find your d In each URI, at the first level, you will find the IDS of each occurrence. For each IDS, you will find the corresponding tree. -In this tree, there are different types of data (Structure, Table, Float, Integer, Text), and each type will have its corresponding icon, except for Structures and Tables, which will share the same icon. +In this tree, there are different types of data (Structure, Table, Float, Integer, Text, Complex), and each type will have its corresponding icon, except for Structures and Tables, which will share the same icon. .. image:: images/tree.png :alt: Tree uri to select data to plot